Skip to content

Commit

Permalink
Move environment YAML file and requirements.txt to new envs/ sub-…
Browse files Browse the repository at this point in the history
…directory (#116)

* Move SalishSeaTools environment.yaml to envs/ dir

Updated paths in documentation and comments to reflect the file move. This
reorganization improves structure by grouping environment-related files
under the `envs` directory.

* Move SalishSeaTools requirements.txt to envs/ dir

Moved requirements.txt to the 'envs/' directory for better organization and
clarity. Updated the comment to reflect the new file path for maintaining
dependencies.

* Rename environment.yaml to environment-dev.yaml

This change updates the environment file name to better reflect its purpose
as a development environment configuration. All references in documentation
and related files have been updated accordingly for consistency.
  • Loading branch information
douglatornell authored Dec 23, 2024
1 parent f3380c6 commit fd03c11
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion SalishSeaTools/docs/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ and building the documentation with the commands:
.. code-block:: bash
$ cd tools
$ conda env create -f SalishSeaTools/environment.yaml
$ conda env create -f SalishSeaTools/envs/environment-dev.yaml
$ conda activate salishsea-tools
(salishsea-tools)$ pip install --editable SalishSeaTools
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
# of the SalishSeaTools package with:
#
# $ cd tools
# $ conda env create -f SalishSeaTools/environment.yaml
# $ conda env create -f SalishSeaTools/envs/environment-dev.yaml
# $ conda activate salishsea-tools
# (salishsea-tools)$ python -m pip install --editable SalishSeaTools
#
# See the requirements.txt file for an exhaustive list of all of the
# See the envs/requirements.txt file for an exhaustive list of all the
# packages installed in the environment and their versions used in
# recent development.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Python packages and version used in development environment
#
# This list is intended to be for reference only.
# Use the conda environment description file (environment.yaml)
# Use the conda environment description file (envs/environment-dev.yaml)
# to create an isolated development environment.
#
# Create/update this file with:
# (salishsea-tools)$ python -m pip list --format=freeze >> SalishSeaTools/requirements.txt
# (salishsea-tools)$ python -m pip list --format=freeze >> SalishSeaTools/envs/requirements.txt

alabaster==1.0.0
angles==2.0
Expand Down
2 changes: 1 addition & 1 deletion SalishSeaTools/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
except IOError:
long_description = ''
install_requires = [
# see requirements.txt for versions most recently used in development
# see envs/requirements.txt for versions most recently used in development
'angles',
'arrow>=1.0.0',
'bottleneck',
Expand Down

0 comments on commit fd03c11

Please sign in to comment.