Commit 03fe1210 authored by Berutti, Michael (Contractor) Charles's avatar Berutti, Michael (Contractor) Charles
Browse files

Merge branch 'master' into 'master'

Merge private to public

Closes #18, #20, #21, #23, #26, #25, #24, #28, #29, #30, #31, #33, #34, #37, #38, #39, #40, #41, and #42

See merge request !49
parents 31480f46 7833b6e5
*.mat -crlf -diff -merge
\ No newline at end of file
*.mat -crlf -diff -merge
# Declare files that will always have CRLF line endings on checkout.
# boundary condition
*.b[[:digit:]][[:digit:]] text eol=crlf
# flow files
*.f[[:digit:]][[:digit:]] text eol=crlf
# plan
*.p[[:digit:]][[:digit:]] text eol=crlf
# project file
*.prj text eol=crlf
# geometry
*.g[[:digit:]][[:digit:]] text eol=crlf
# unsteady flow
*.u[[:digit:]][[:digit:]] text eol=crlf
# output file
*.O[[:digit:]][[:digit:]] binary
# hdf files
*.hdf binary
import sys
from PyQt5.QtWidgets import QApplication
from fluegggui.gui import AppWindow
if __name__ == '__main__':
# Initialize the UI
app = QApplication(sys.argv)
w = AppWindow()
w.show()
sys.exit(app.exec_())
......@@ -21,7 +21,7 @@ project = 'fluegg'
author = 'USGS'
# The full version, including alpha/beta/rc tags
release = '0.0.0'
release = '4.1.0'
# -- General configuration ---------------------------------------------------
......
......@@ -16,6 +16,7 @@ fluegg.asiancarpeggs module
:members:
:undoc-members:
:show-inheritance:
fluegg.drift module
-------------------
......@@ -23,6 +24,7 @@ fluegg.drift module
:members:
:undoc-members:
:show-inheritance:
fluegg.hydraulics module
------------------------
......@@ -30,6 +32,7 @@ fluegg.hydraulics module
:members:
:undoc-members:
:show-inheritance:
fluegg.kml module
-----------------
......@@ -37,6 +40,7 @@ fluegg.kml module
:members:
:undoc-members:
:show-inheritance:
fluegg.random module
--------------------
......@@ -44,6 +48,7 @@ fluegg.random module
:members:
:undoc-members:
:show-inheritance:
fluegg.ras module
-----------------
......@@ -51,6 +56,23 @@ fluegg.ras module
:members:
:undoc-members:
:show-inheritance:
fluegg.results module
-----------------
.. automodule:: fluegg.results
:members:
:undoc-members:
:show-inheritance:
fluegg.resultsrecorder module
-----------------------------
.. automodule:: fluegg.resultsrecorder
:members:
:undoc-members:
:show-inheritance:
fluegg.simclock module
----------------------
......@@ -58,6 +80,7 @@ fluegg.simclock module
:members:
:undoc-members:
:show-inheritance:
fluegg.simulation module
------------------------
......@@ -65,6 +88,7 @@ fluegg.simulation module
:members:
:undoc-members:
:show-inheritance:
fluegg.transporter module
-------------------------
......
......@@ -42,7 +42,7 @@ SSH key to your GitLab account**.
ssh -T git@code.usgs.gov
```
## 3. Clone the repository
## 4. Clone the repository
Cloning the repository downloads a copy of the Git repository to your
local machine. This repository contains a history of changes, and most
importantly, the FluEgg code. Cloning the repository will also create a
......@@ -58,7 +58,7 @@ C:\path-to-sources>` is the command prompt).
(base) C:\path-to-sources>git clone git@code.usgs.gov:FluEgg/fluegg.git
```
## 4. Create and activate the fluegg conda environment
## 5. Create and activate the fluegg conda environment
In this step, you will create an Anaconda environment that contains the version
of Python and versions of packages that are known to work with the FluEgg code
......@@ -87,7 +87,7 @@ development environment.
(fluegg) C:\path-to-sources\fluegg>
```
## 5. Install the fluegg environment
## 6. Install the fluegg environment
The fluegg environment contains Python packages that the fluegg package is
known to work with.
......@@ -107,7 +107,7 @@ Next, install the packages in the environment using pip.
(fluegg) C:\path-to-sources\fluegg>pip install -r requirements.txt
```
## 6. Install the fluegg package
## 7. Install the fluegg package
In order for the Python interpreter in the fluegg environment to have "global"
access to the fluegg package, you'll have to install the package within the
......@@ -121,7 +121,7 @@ fluegg environment.
The `-e` option tells pip to install the fluegg package in "editable" mode.
See ["Editable" installs](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs) for more info.
## 7. Run the FluEgg unit tests
## 8. Run the FluEgg unit tests
Running the unit tests will ensure the environment is set up and the FluEgg
code is working correctly.
......@@ -142,7 +142,7 @@ OK
The tests passing is a clear indicator that the FluEgg environment has been set
up correctly. You're ready to begin working with the code.
## 8. Build the code documentation
## 9. Build the code documentation
Currently, only the docstrings within the FluEgg code are available in the
documentation.
......
This source diff could not be displayed because it is too large. You can view the blob instead.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment