New structure of ww3_tools, adding modularization and allowing pip install.
Description
New setup.py to allow the package to be pip installed.
Instructions for installation are included in README.md. The installation is composed of two steps,
with pip install . , and prepww3tools.py which verifies the installation, organizes the directories, and downloads the observations.
New functions were added to wread.py followed by updates.
The old scripts get* to download NDBC and Copernicus buoys were combined into a new module wfetchbuoy.py
Issue(s) addressed
The lack of modularization was initially addressed and stand-alone scripts were converted to functions/modules, such as ww3fields.py. The new structure allows package installation that facilitates and expands usability.
wfetchbuoy.py and wread.py are the two modules/functions that had the most changes and improvements. And prep_ww3tools.py is a new script to complete the installation.
Commit Message
New structure of ww3_tools, adding modularization and allowing pip install.
Check list
[x] ww3_tools installation is working, imports and functionalities were tested
[x] prep_ww3tools.py allows a customized installation and facilitates the download of observation and grid information.
[x] new functions associated with new buoy and ww3 file formats were added to wread.py.
[x] files renamed to improve clarity.
Testing
ww3tools were installed and tested, all the options of installation with prep_ww3tools.py were tested, and all the buoy and ww3 file formats in wread.py were tested.
Pull Request Summary
New structure of ww3_tools, adding modularization and allowing pip install.
Description
New setup.py to allow the package to be pip installed. Instructions for installation are included in README.md. The installation is composed of two steps, with pip install . , and prepww3tools.py which verifies the installation, organizes the directories, and downloads the observations. New functions were added to wread.py followed by updates. The old scripts get* to download NDBC and Copernicus buoys were combined into a new module wfetchbuoy.py
Issue(s) addressed
The lack of modularization was initially addressed and stand-alone scripts were converted to functions/modules, such as ww3fields.py. The new structure allows package installation that facilitates and expands usability. wfetchbuoy.py and wread.py are the two modules/functions that had the most changes and improvements. And prep_ww3tools.py is a new script to complete the installation.
Commit Message
New structure of ww3_tools, adding modularization and allowing pip install.
Check list
Testing
ww3tools were installed and tested, all the options of installation with prep_ww3tools.py were tested, and all the buoy and ww3 file formats in wread.py were tested.