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

dev: comment and cleanup environment.yml #295

Merged
merged 11 commits into from
Aug 22, 2023
75 changes: 39 additions & 36 deletions environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,57 +5,60 @@ channels:
- plotly
- defaults
dependencies:
- cython
- distributed==2021.1.0
- dask==2021.1.0
- python-graphviz
- pytest
- decorator
- docutils
- graphviz
- ipywidgets<8.0.0
- ipython
- ipygany
- jedi
- jinja2
- jupyter_contrib_nbextensions
# mdanalysis dependencies
- matplotlib
jandom marked this conversation as resolved.
Show resolved Hide resolved
- nbclient
- nbconvert
- nbformat
- nbsphinx
- networkx
jandom marked this conversation as resolved.
Show resolved Hide resolved
- nglview
- notebook
- numpy
- openmm>=7.0.0
- packaging
jandom marked this conversation as resolved.
Show resolved Hide resolved
- parmed
- parso
- pip
- plotly
- pybtex
- python=3.9
- pyvista
- scikit-image
- scikit-learn>=1.1.2
- threadpoolctl
jandom marked this conversation as resolved.
Show resolved Hide resolved
- pyedr>=0.7
# building documentation
- docutils
- pandoc
- pybtex
- sphinx
- sphinxcontrib-bibtex
- threadpoolctl
# used by custom_parallel_analysis.ipynb
- graphviz
- tabulate
- widgetsnbextension
- ipycytoscape>=1.3.0
- python-graphviz
Copy link
Member

Choose a reason for hiding this comment

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

Could you move this down to #visualisation?

# extensions
- jupyter_contrib_nbextensions
- nbconvert # not called by any notebook explicitly but to download notebooks, or in nbsphinx
- nbformat
- notebook<7
# used for visualising/plotting
- plotly
- ipygany
- pyvista
- scikit-image
- seaborn>=0.12.1
- openmm>=7.0.0
- pandoc
# parallelization
- distributed==2021.1.0
- dask==2021.1.0
# used for visualising/making movies of molecules;
- nglview
- moviepy
- ipyvtklink
# used in conf.py
Copy link
Member

Choose a reason for hiding this comment

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

I mostly think of these as sphinx "extensions" -- we use the ipython directive in some docs, nbsphinx to render notebooks, etc. If they're imported/used in conf.py it would generally be in their role as extensions.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, yeah, easy to change

Copy link
Member

Choose a reason for hiding this comment

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

Thanks @jandom -- could you please move these up to the #extensions then?

Copy link
Member

Choose a reason for hiding this comment

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

Just this to go -- nbsphinx, ipywidgets and the like are used to render notebooks, and IIRC ipython to use the ipython sphinx directive. If they're imported in conf.py it's to configure settings but, otherwise they fall into the same category as other extensions, e.g. sphinx bibtex.

- ipython
- ipywidgets<8.0.0
- nbsphinx
# used for notebook testing
- pytest
- python=3.9
- pip
- pip:
- sphinx_rtd_theme
# used in conf.py
jandom marked this conversation as resolved.
Show resolved Hide resolved
- msmb_theme
- sphinx_rtd_theme
- sphinx-sitemap
jandom marked this conversation as resolved.
Show resolved Hide resolved
# used for notebook testing
- nbval
# developer tooling
- pre-commit
- pyedr>=0.7
# mdanalysis and its tests and test data
- git+https://github.com/MDAnalysis/mdanalysis@develop#egg=mdanalysis&subdirectory=package
- git+https://github.com/MDAnalysis/mdanalysis@develop#egg=MDAnalysisTests&subdirectory=testsuite
- git+https://github.com/MDAnalysis/MDAnalysisData@master#egg=MDAnalysisData