diff --git a/README.md b/README.md index e34961d..df9dc80 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,14 @@ Install from PyPI with: pip install ocelot ``` +To install dependencies required for cluster simulation, you'll need to do + +```bash +pip install ocelot[simulate] +``` + +due to a separate issue that's currently being resolved in one of our dependencies. + Currently, using `ocelot.simulate` also requires manually downloading data from [here](https://drive.google.com/file/d/1wMXymFHo-K5jdIGoJi5oGuHeXSa3JVmu/view?usp=sharing). Place it at a directory of your choosing, and set the environment variable `OCELOT_DATA` to this location. If you're just working with a local dev copy of ocelot (i.e. you installed it via git clone), then you could put the data at the default location - /data in this folder. diff --git a/docs/installation.md b/docs/installation.md index 272e2ba..5ff4bc8 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -8,6 +8,14 @@ pip install ocelot to get started, which will install the latest release of the code. +To install dependencies required for cluster simulation, you'll need to do + +```bash +pip install ocelot[simulate] +``` + +due to a separate issue that's currently being resolved in one of our dependencies. + ## Getting additional data diff --git a/pyproject.toml b/pyproject.toml index 42092d7..5bc6765 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "ocelot" # Required -version = "0.4.0" # Required +version = "0.4.1" # Required description = "A toolbox for working with observations of star clusters." # Optional readme = "README.md" # Optional requires-python = ">=3.10" @@ -33,7 +33,6 @@ dependencies = [ "astropy>=6.0.0,<7.0", "healpy>1.13.0,<2.0", # Todo consider removing dependency - switch to Astropy's healpy implementation "galpy>1.9,<2.0", # Todo consider removing dependency - "imf @ git+https://github.com/keflavich/imf", "dustmaps", # Todo is this needed? "gaiaunlimited", # Todo make optional? "kepler.py", # For advanced calculations of the separations of binary stars @@ -41,6 +40,9 @@ dependencies = [ [project.optional-dependencies] +simulate = [ + "imf @ git+https://github.com/keflavich/imf", +] dev = [ "mkdocs-material[imaging]", "mkdocstrings[python]>=0.18",