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

Confused about multiple environment.yaml: Are both needed? #69

Closed
mccalluc opened this issue Jun 7, 2021 · 1 comment · Fixed by #71
Closed

Confused about multiple environment.yaml: Are both needed? #69

mccalluc opened this issue Jun 7, 2021 · 1 comment · Fixed by #71

Comments

@mccalluc
Copy link
Contributor

mccalluc commented Jun 7, 2021

The README currently says to install the top-level one, but when @keller-mark set me on the right path he pointed me at docs/notebooks/environment.yml... Should there be two? Either more explanation, or deleting one, may be helpful.

diff environment.yml docs/notebooks/environment.yml
1c1
< name: vitessce-jupyter-dev
---
> name: vitessce-jupyter-examples
6c6
<  - python==3.8
---
>  - python>=3.7
9a10,12
>  - numba>=0.53.0
>  - scanpy>=1.6.0
>  - jupyterlab>=3
11,14c14
<  - numcodecs>=0.7.2
<  - scipy>=1.0.0
<  - nbsphinx>=0.7.1
<  - pandoc>=2.11.3
---
>  - boto3>=1.16.30
17d16
<    - build==0.1.0
19,22c18
<    - sphinx
<    - sphinx-rtd-theme
<    - nbclean>=0.3.2
<    - generate-tiff-offsets>=0.1.7
---
>    - scikit-misc>=0.1.3
@keller-mark
Copy link
Member

keller-mark commented Jun 7, 2021

The top-level environment is for the development of the vitessce package itself.

The inner environment is for running the example notebooks in docs/notebooks. The package does not depend on Jupyter or ScanPy, for instance, but running the notebooks does.

We do have a second readme at docs/notebooks/README.md but you have a good point that we should explain this in the root README.md.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants