+
Skip to content

Documentation updates to install WNTR without Anaconda #403

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jan 29, 2024
Merged

Documentation updates to install WNTR without Anaconda #403

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions documentation/getting_started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,16 @@ For example, to run the pipe criticality example, run the following command::

Additionally, the examples folder contains demonstrations using Jupyter Notebooks.
A Jupyter Notebook, an open-sourced web-based application, can be accessed through Anaconda or by installing the
associated software available at https://jupyter.org. These demonstrations include the following:
associated software available at https://jupyter.org.

.. note::
When running Jupyter Notebooks outside of an Anaconda environment:

* Install Jupyter Notebook within the virtual environment that also contains WNTR before launching any notebooks.
* Ensure all example files are in the same directory as the virtual environment.
* Run the notebook from this specific directory to maintain correct file path references.

WNTR Jupyter Notebook demonstrations include the following:

* `Pipe break demo <https://github.com/USEPA/WNTR/blob/main/examples/demos/pipe_break_demo.ipynb>`_:
This demonstration runs multiple hydraulic simulations to compute the impact that different individual pipe breaks/closures have on network pressure.
Expand All @@ -95,6 +104,5 @@ The Jupyter Notebook will open in a browser (e.g., Chrome, Firefox) and the exam
Additional information on Jupyter Notebooks is available at https://jupyter.org.

For more details about the steps in the demonstrations, review Chapter 12: Water network tool for resilience in
`Embracing Analytics in the Drinking Water Industry <https://iwaponline.com/ebooks/book/849/Embracing-Analytics-in-the-Drinking-Water-Industry>`_.


`Embracing Analytics in the Drinking Water Industry <https://iwaponline.com/ebooks/book/849/Embracing-Analytics-in-the-Drinking-Water-Industry>`_.

14 changes: 9 additions & 5 deletions documentation/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ Step 1: Setup the Python environment
WNTR requires 64-bit Python (tested on versions 3.7, 3.8, 3.9, and 3.10) along with several Python package dependencies.
Python distributions, such as Anaconda, are recommended to manage
the Python environment. Anaconda can be downloaded from https://www.anaconda.com/products/individual.
Additional instructions for setting up a Python environment independent of Anaconda are available at https://docs.python.org/.
General information on Python can be found at https://www.python.org/.

.. note::
Expand All @@ -74,17 +75,20 @@ Step 1: Setup the Python environment
While the second option allows the user to define priority, this requires administrator privileges.
If Anaconda is not added to the PATH environment variable, Python can be run by using the full path name (e.g., C:\\Users\\username\\Anaconda3\\python).

Anaconda includes the Python packages needed for WNTR, including NumPy, SciPy, NetworkX, pandas, and
Anaconda includes the Python packages needed for WNTR, including NumPy, SciPy, NetworkX, Pandas, and
Matplotlib. For more information on Python package dependencies, see :ref:`requirements`.
If the Python installation does not include these dependencies, the user will need to install them.
This is most commonly done using pip or conda.
Detailed guidance concerning package installation using pip is available at https://packaging.python.org/.

Anaconda also comes with Spyder, an IDE, that includes enhanced
editing and debugging features along with a graphical user interface.
Debugging options are available from the toolbar.
Code documentation is displayed in the object inspection
window. Pop-up information on class structure and functions are displayed in the
editor and console windows.
The IDE provides debugging options accessible from the toolbar,
displays code documentation in the object inspection window, and
shows pop-up information on class structure and functions in the
editor and console windows. Non-Anaconda users can download
Spyder from https://www.spyder-ide.org/.
For a detailed installation guide, please refer to https://docs.spyder-ide.org/.

To open a Python console, open a command prompt (cmd.exe on Windows, terminal window on Linux and Mac OS X)
and run 'python', as shown in :numref:`fig-cmd-python`,
Expand Down
点击 这是indexloc提供的php浏览器服务，不要输入任何密码和下载