Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Install assimulo from conda-forge #2455

Merged
merged 1 commit into from
Oct 11, 2022

Conversation

heplesser
Copy link
Contributor

The aeif_models_implementation requires the assimulo package to compute reference solutions. The notebook previously suggested installation from PyPi, but assimulo is outdated there (3.0 from 2018) and does not build any longer. A current version is available on conda-forge. This PR therefore adds assimulo to environments.yml and updates the requirements information in the notebook.

@jougs @terhorstd Since this introduces yet another dependency for a corner case, I'd like your comments.

Fixes #2454.

@heplesser heplesser added S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation. I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) labels Aug 21, 2022
@heplesser heplesser added this to In progress in Documentation via automation Aug 21, 2022
Copy link
Contributor

@jessica-mitchell jessica-mitchell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The notebook works! Thanks @heplesser

@jougs
Copy link
Contributor

jougs commented Oct 10, 2022

Phew... Honestly, I don't like the fact that this adds a dependency on conda to build the full docs. I have now contacted the main developer of Assimulo and asked for an update of the PyPI package and would like to keep this un-merged until I get an answer from him.

@heplesser
Copy link
Contributor Author

@jougs Why do you consider a conda-dependency more problematic than a PyPI dependency? That said, I am wondering if it could make sense to move background documents such as this to a separate repository to avoid too many dependencies in the NEST code base itself.

Copy link
Contributor

@jougs jougs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I always feel like conda is the odd one out, because it is not installable/updatable via my system's trusted repository, while pip is. I'm usually trying to avoid either if I can, but assimulo is also not available via apt-get...

Splitting the documentation would not be a good idea in my view, as that has a high potential of things getting outdated and forgotten.

Thinking about it again, I realize that this is only a run-time dependency, and I can probably live well with it being mentioned in the environment.yaml, which I'm anyway not using. I'm thus approving.

@heplesser heplesser removed the request for review from terhorstd October 11, 2022 20:24
@heplesser heplesser merged commit 6a166a9 into nest:master Oct 11, 2022
Documentation automation moved this from In progress to Done Oct 11, 2022
@heplesser heplesser deleted the fix-2454-aeif-notebook branch October 17, 2022 19:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation.
Projects
Documentation
  
Done
Development

Successfully merging this pull request may close these issues.

aeif_models_implementation fails to execute
3 participants