From 065ecd718f176dffd9fa8df9b1e208f525bae41b Mon Sep 17 00:00:00 2001 From: emilyhunt Date: Tue, 14 Oct 2025 16:57:29 +0200 Subject: [PATCH] Various improvements to readme --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 470160d..02fa0fe 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,16 @@ The package can be installed via pip with pip install hr_selection_function ``` -It will handle fetching data automatically. +Note that installation on Windows is probably not possible at this time, as [healpy](https://github.com/healpy/healpy) does not support Windows. + +The package will handle fetching data [from Zenodo](https://zenodo.org/records/17350533) automatically. You can control which directory is used for storing data either with the `HRSF_DATA` environment variable, or by calling `set_data_directory` **every time** you use the package: + +```python +from hr_selection_function import set_data_directory +set_data_directory("/path/to/desired/location") +``` + +Otherwise, data is stored by default at `$HOME/.hr_selection_function`. ## Basic use @@ -87,6 +96,11 @@ n_stars_predicted, median_parallax_error_predicted = nstars_model( You can find more examples in the 'examples' directory. +## Issues + +If you encounter any problems with using the package, then please raise an issue on [GitHub](https://github.com/emilyhunt/hr_selection_function/issues). + + ## Developing We recommend using [uv](https://docs.astral.sh/uv/) if you want to contribute to the package. Installing the same Python version and packages to a new virtual environment is then as easy as -- 2.51.2