Package: nautical
NauticalDescriptionAhoy! Whether you've got your sea legs under yeh', or you're just looking to get those toes wet, you have discovered Nautical. Nautical is a web scraper that allows its users to parse real time data fromNOAA'sbuoys. You can try Nautical as a python or GO package! Nautical was created for research and data logging purposes, but there are many more possibilities for users to discover.If you would like to view the python documentation follow thelink to nautical's python documentation.If you would like to view the GO documentation follow thelink to nautical's GO documentation.Table of ContentsFeaturesBuoysSourcesData CachingPrerequisitesCasting OffTutorialsTestingPythonGolangContributingContribution FlowSuggested Commit Message FormatCopyrightFeaturesThe following are a set of features and/or data that can be accessed via the package.SourcesA source is a group of buoys. The source can be thought of as a sponsor or owner of the group/set of buoys. The source may be used as an indicator of the type of data that is stored in a buoy object.Note: TheTAOandTsunamisources are not available in any regard.BuoysA buoymaycontain, but are not limitted to, any of the following variables.DataAbbreviationUnitsWind SpeedwspdKnotsGustgstKnotsWave HeightwvhtFeetDominant Wave PerioddpdSecondsAverage Wave PeriodapdSecondsPressurepresPSIPressure TendencyptdyPSIAir TemperatureatmpFahrenheitWater TemperaturewtmpFahrenheitDew PointdewpFahrenheigtSalinitysalPSUVisibilityvisNautical MilesTidetideFeetSwell HeightswhFeetSwell Wave PeriodswpSecondsWind Wave HeightwwhFeetWind Wave PeriodwwpSecondsOcean TemperatureotmpFahrenheitWind Speed 10m Intervalwspd10mKnotsWind Speed 20m Intervalwspd10mKnotsDepthdepthFeetData CachingThe cache can be used to save and load information about buoys and sources. The feature enables users to locally store and retrieve older information. NOAA refreshes the online data roughly every 30 minutes. The cache package can be used to throttle data retrieval calls to ensure the user is not wasting system resources when data has not been updated by NOAA.Create cache filesCopy cache files to new names (with timestamps or custom names)Load Cache files to Nautical Objects.Note:Nautical cachewas added in version 3.1.0.PrerequisitesThe python package requirespython>=3.6. You can use a package manager to install a version of python that satifies the requirements, or you may manually install python from thewebsite.The GO package requiresgolang>=1.18. To install go please visit the officialwebsite.Note:The GO requirement is not strict, but previous versions have Not been tested.Casting OffEnsure your system meets theprerequisites.Clone or Fork the repository.Run thepackage testsTutorialsFollow the link to view thetutorials for the python package.Follow the link to view thetutorials for the go package.TestingPythonAll python tests are located in thetestsdirectory.python3.x-mvenvvenvsourcevenv/bin/activate
pipinstall-rrequirements.txt
pipinstall-rtest_requirements.txt
pytest--cov=testsNote:The virtual environment and coverage are optional.GOAll golang tests are located with the golang source inpkg. The following should be executed from the project home directory.goget-u
gotest-v./...ContributingFor more information on contributing to the project, please seecontributing.CopyrightCopyright © 2022, Brent Barbachem. Released under theMIT License.