Skip to content

Commit

Permalink
Move IMF to optional deps
Browse files Browse the repository at this point in the history
  • Loading branch information
emilyhunt committed Jan 20, 2025
1 parent 3844ec3 commit c69f6af
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 2 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
8 changes: 8 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 4 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -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"
Expand Down Expand Up @@ -33,14 +33,16 @@ 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
]


[project.optional-dependencies]
simulate = [
"imf @ git+https://github.com/keflavich/imf",
]
dev = [
"mkdocs-material[imaging]",
"mkdocstrings[python]>=0.18",
Expand Down

0 comments on commit c69f6af

Please sign in to comment.