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

Cleaner environment #23

Closed
RondeauG opened this issue Aug 30, 2023 · 3 comments · Fixed by #30
Closed

Cleaner environment #23

RondeauG opened this issue Aug 30, 2023 · 3 comments · Fixed by #30
Assignees

Comments

@RondeauG
Copy link
Collaborator

RondeauG commented Aug 30, 2023

Generic Issue

  • xhydro version: 0.1.5

environment.yml currently has many dependencies that should either be removed or moved to environment-docs (such as the sphinx ones). environment.yml should be kept as lean as possible, then populated as we add functions.

We also have 5 files where dependencies are listed. I think that we can get rid of a few of them.

Additional context

Original conversation in #11 (comment)

@RondeauG
Copy link
Collaborator Author

RondeauG commented Aug 30, 2023

name: xhydro
channels:
  - conda-forge
dependencies:
  - python >=3.9
  - dask
  - numpy
  - pandas >=2.0
  - scipy
  - statsmodel
  - xarray
  - xclim >=0.44.0
  - xscen >=0.7.1

Taking into account the currently opened PRs, I think that something like this could work.

@RondeauG
Copy link
Collaborator Author

Additional dependencies for a environment-dev.yml. This is mainly copy-pasted from xscen. @Zeitsperre, could you look at this list?

  # Dev
  - bumpversion
  - coveralls
  - furo               # Added, as it seems to be the style we're using, per previous conversation
  - hvplot             # I removed it from the previous list, but we'll likely need this for the docs.
  - ipykernel
  - ipython
  - jupyter_client
  - matplotlib         # I removed it from the previous list, but we'll likely need this for the docs.
  - nbsphinx
  - nbval
  - pandoc
  - pooch
  - pre-commit
  - pytest
  - pytest-cov
  - sphinx
  - sphinx-autoapi
  - sphinx-rtd-theme >=1.0   # Mutually exclusive to 'furo'?
  - sphinxcontrib-napoleon
  - sphinx-codeautolink
  - sphinx-copybutton
  - pip
  - pip:
    - xdatasets    # I saw it added to #20, but I think that this is only for the documentation?
  # Testing
  - tox <4.0 # 2022-12-12: tox v4.0 is incompatible with tox-conda plugin
  - tox-conda >=0.10.2
  # packaging
  - build
  - wheel

@Zeitsperre
Copy link
Collaborator

  # Dev
  - bumpversion

I would use bump2version (more maintained fork)

  - coveralls
  - furo               # Added, as it seems to be the style we're using, per previous conversation
  - hvplot             # I removed it from the previous list, but we'll likely need this for the docs.
  - ipykernel
  - ipython
  - jupyter_client
  - matplotlib         # I removed it from the previous list, but we'll likely need this for the docs.
  - nbsphinx
  - nbval
  - pandoc
  - pooch
  - pre-commit
  - pytest
  - pytest-cov
  - sphinx
  - sphinx-autoapi
  - sphinx-rtd-theme >=1.0   # Mutually exclusive to 'furo'?

sphinx-rtd-theme can be removed.

  - sphinxcontrib-napoleon
  - sphinx-codeautolink
  - sphinx-copybutton
  - pip
  - pip:
    - xdatasets    # I saw it added to #20, but I think that this is only for the documentation?

If we have a permanent location for the documentation, we should be able to link directly to it with intersphinx. Is xdatasets slated to become a formal dependency here?

 # Testing
  - tox <4.0 # 2022-12-12: tox v4.0 is incompatible with tox-conda plugin
  - tox-conda >=0.10.2

We aren't using tox-conda here and the min_version is to set 4.0. I would remove tox-conda and set tox >=4.0

 # packaging
  - build
  - wheel

These two will be removed once we migrate.

@RondeauG RondeauG mentioned this issue Sep 13, 2023
5 tasks
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.

3 participants