Skip to content

Commit

Permalink
Remove setup.py references from docs
Browse files Browse the repository at this point in the history
  • Loading branch information
John-Sharples committed Nov 17, 2024
1 parent 810c61d commit a5455af
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ For information about the support provided for releases, see our [Release Suppor
Instructions for installing the metcalcpy package locally
---------------------------------------------------------
- activate your conda environment (i.e. 'conda activate your-conda-env-name')
- from within your active conda environment, cd to the METcalcpy/ directory, where you will see the setup.py script
- from within your active conda environment, cd to the METcalcpy/ directory, where you will see the file pyproject.toml
- from this directory, run the following on the command line: pip install -e .
- the -e option stands for editable, which is useful in that you can update your METcalcpy/metcalcpy source without reinstalling it
- the . indicates that you should search the current directory for the setup.py script
- the . indicates that you should search the current directory for the pyproject.toml file.

- use metcalcpy package via import statement:
- Examples:
Expand Down
2 changes: 1 addition & 1 deletion docs/Users_Guide/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ METcalcpy source code, e.g. `/User/someuser/METcalcpy`. From this directory, ru

`pip install -e .`

This instructs pip to install the package based on instructios in the setup.py file located in the current directory
This instructs pip to install the package based on instructios in the pyproject.toml file located in the current directory
(as indicated by the '.'). The `-e` directs pip to install the package in edit mode, so if one wishes to make changes
to this source code, the changes are automatically applied without the need to re-install the package.

Expand Down

0 comments on commit a5455af

Please sign in to comment.