diff --git a/docs/usage.rst b/docs/usage.rst index 90affa7..fa3b31a 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -2,6 +2,8 @@ Usage ===== -To use RAMP_GUI in a project:: +To use RAMP_GUI:: - import ramp_gui +1. Create an environment with the requirements. + +2. python main.py diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..b546d54 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,26 @@ +contourpy==1.2.1 +cycler==0.12.1 +et-xmlfile==1.1.0 +fonttools==4.51.0 +kiwisolver==1.4.5 +matplotlib==3.9.0 +numpy==1.26.4 +openpyxl==3.1.2 +packaging==24.0 +pandas==2.2.2 +pillow==10.3.0 +plotly==5.22.0 +pyparsing==3.1.2 +PyQt5==5.15.10 +PyQt5-Qt5==5.15.13 +PyQt5-sip==12.13.0 +PyQt5-stubs==5.15.6.0 +python-dateutil==2.9.0.post0 +pytz==2024.1 +ramp==0.1.4 +rampdemand==0.5.0 +six==1.16.0 +tenacity==8.3.0 +tqdm==4.66.4 +tzdata==2024.1 +XlsxWriter==3.2.0 diff --git a/requirements_dev.txt b/requirements_dev.txt index 474bd7f..7a19446 100644 --- a/requirements_dev.txt +++ b/requirements_dev.txt @@ -1,11 +1,10 @@ -pip==23.3 -bump2version==0.5.11 -wheel==0.38.1 -watchdog==0.9.0 -tox==3.14.0 -coverage==4.5.4 -Sphinx==7.2.6 -twine==5.0.0 -ruff==0.3.5 +bump2version +wheel +watchdog +tox +coverage +Sphinx +twine +ruff diff --git a/tests/test_ramp_gui.py b/tests/test_ramp_gui.py index 352d9f5..94fab8e 100644 --- a/tests/test_ramp_gui.py +++ b/tests/test_ramp_gui.py @@ -4,8 +4,7 @@ import unittest - -from ramp_gui import ramp_gui +from src.ramp_gui import ramp_gui class TestRamp_gui(unittest.TestCase): @@ -19,3 +18,4 @@ def tearDown(self): def test_000_something(self): """Test something.""" + ramp_gui.ramp_gui()