Skip to content

Commit

Permalink
Change IMF dependency to new PyPI package
Browse files Browse the repository at this point in the history
  • Loading branch information
emilyhunt committed Jan 21, 2025
1 parent a28f2bf commit a511705
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 51 deletions.
10 changes: 1 addition & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,6 @@ 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 All @@ -52,7 +44,7 @@ git clone https://github.com/emilyhunt/ocelot
uv sync --all-extras
```

After installing development dependencies, you can also make and view edits to the package's documentation. To view a local copy of the documentation, do `mkdocs serve`. You can do a test build with `mkdocs build`.
After installing development dependencies, you can also locally view edits to the package's documentation. To view a local copy of the documentation, do `mkdocs serve`. You can do a test build with `mkdocs build`.


## Citation
Expand Down
8 changes: 0 additions & 8 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,6 @@ 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
8 changes: 4 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -84,15 +84,15 @@ nav:
- Getting Started:
- Overview: 'index.md'
- Installation: 'installation.md'
- ocelot's best bits: 'features.md'
- Features: 'features.md'
# - Configuration: 'wip.md'
- Citing ocelot: 'wip.md'
- Citing ocelot: 'citation.md'
# - Further reading: 'wip.md'
- Technical Stuff:
- Changelog: 'changelog.md'
- Report an issue: 'wip.md'
- Report an issue: 'issue.md'

- Examples:
- Tutorials:
# - Star clusters in Gaia data:
# - Detect a star cluster in Gaia data: 'wip.md'
# - Crossmatching catalogues: 'wip.md'
Expand Down
6 changes: 2 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,11 @@ dependencies = [
"dustmaps", # Todo is this needed?
"gaiaunlimited", # Todo make optional?
"kepler.py", # For advanced calculations of the separations of binary stars
"initial_mass_function==2025.1.20", # N.B. imports as 'imf'
]


[project.optional-dependencies]
simulate = [
"imf @ git+https://github.com/keflavich/imf",
]
dev = [
"mkdocs-material[imaging]",
"mkdocstrings[python]>=0.18",
Expand All @@ -51,7 +49,7 @@ dev = [
"check-manifest",
"pytest",
"ruff",
"ezpadova @ git+https://github.com/mfouesneau/ezpadova", # PARSEC isochrone download
# "ezpadova @ git+https://github.com/mfouesneau/ezpadova", # PARSEC isochrone download # Todo get it on a release schedule / link to github .zip file
]
docs = [
"mkdocs-material[imaging]",
Expand Down
40 changes: 14 additions & 26 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit a511705

Please sign in to comment.