Merge pull request #14 from pace-gt/code_updated_jan_2026

Code updated jan 2026

Author: bcrawford39GT

README.md

@@ -1,4 +1,4 @@
-#  python_github_tutorial 
+#  python_github_tutorial
 
 ## Overview
 
@@ -12,21 +12,33 @@ To be added in the future.
 
 ## Installation
 
+This project's environment can be built using `miniforge`.
+Alternative software for `miniforge`:
+- You use can use `anaconda` or `miniconda`, which use the same `conda` command.
+- You use can use `micromamba` or `mamba`,  supplimenting `micromamba` or `mamba` respectively for `conda` when using them.
+
 The  python_github_tutorial package dependencies can be installed via conda, and this package tagged in conda via pip install:
 
 Create and install conda package:
 
-`cd path_to_first_python_github_tutorial_dirctory_with_environment_yml_file`
+cd "<YOUR_FILE_PATH/python_github_tutorial>"
+
+`cd python_github_tutorial`
+
+Create the environment
 
 `conda env create -f environment.yml`
 
+Activate the environment the environment
+
 `conda activate python_github_tutorial`
 
+Install the developement enviroment
+
 `pip install -e .`
 
 Note: If you update the conda package, you may have to redo the pip install.  Without doing this, it may allow incompatable versions of the dependencies to be installed, etc.:
 
-`pip install -e .`
 
 ## Run the example
 
@@ -38,20 +50,20 @@ The example is located here 'examples_to_run/examples.py'. The instructions to r
 
 `python examples.py`
 
-## Run the interactive example in Visual Studios Code (VScode) 
+## Run the interactive example in Visual Studios Code (VScode)
 
-This is the same example but running it as an interactive job (i.e., like a Jupyter notebook). The example is located here 'examples_to_run/interactive_examples.py'.  
+This is the same example but running it as an interactive job (i.e., like a Jupyter notebook). The example is located here 'examples_to_run/interactive_examples.py'.
 
 When using Visual Studios Code (VScode), the '# %%' above each section makes it a cell, which can be run individually by holding shift and pressing enter.
 
 
 ## Run the test cases (unit tests) using pytest
 
-The python_github_tutorial software tests the installation using [pytest](https://docs.pytest.org/en/stable/). 
-The unit tests via ``pytest`` ensure that the code is build properly, running correctly and producing 
-accurate results.  
+The python_github_tutorial software tests the installation using [pytest](https://docs.pytest.org/en/stable/).
+The unit tests via ``pytest`` ensure that the code is build properly, running correctly and producing
+accurate results.
 
-To perform these tests (unit tests) for the python_github_tutorial package, please run the following commands 
+To perform these tests (unit tests) for the python_github_tutorial package, please run the following commands
 from the ``python_github_tutorial/tests`` directory:
 
 Run all the tests:
@@ -74,13 +86,17 @@ Run individual test on 'test_main_functions.py':
 
 ## Build the documentation (docs)
 
-Building these HTML files locally via sphinx, which will allow you to access them with your 
-local internet browsing application or HTML viewer (chrome, safari, VScode, etc.). 
-The HTML files will be located in the ``docs/_build/html`` directory after they are built.  
+Building these HTML files locally via sphinx, which will allow you to access them with your
+local internet browsing application or HTML viewer (chrome, safari, VScode, etc.).
+The HTML files will be located in the ``docs/_build/html`` directory after they are built.
 
-The python_github_tutorial utilizes [sphinx](https://www.sphinx-doc.org/en/master/index.html) to construct the documentation. 
+The python_github_tutorial utilizes [sphinx](https://www.sphinx-doc.org/en/master/index.html) to construct the documentation.
 The user can build the documentation locally by executing the following command from the ``docs`` directory:
-    
+
 `conda activate python_github_tutorial`
-    
-`make html`
+
+`cd python_github_tutorial/docs`
+
+`make html`
+
+You can find the docs `html` build here -> `docs/_build/html`.  When in the `docs/_build/html` directory, click on any `html` file and it will open the full docs.

environment.yml

@@ -8,12 +8,12 @@ dependencies:
   - pytest
   - pip
   - mock
-  - ipython 
-  - nbconvert 
-  - jupyter 
+  - ipython
+  - nbconvert
+  - jupyter
   - pygments
   - numpydoc
-  - sphinx=6.1.1
+  - sphinx
   - sphinx_rtd_theme
   - nbsphinx
   - sphinxcontrib