From c5ec7fca40d89062578295f8f8865992ecfdc3bd Mon Sep 17 00:00:00 2001 From: Brent Barbachem Date: Fri, 15 Jul 2022 21:05:50 -0400 Subject: [PATCH] Updated References. --- README.md | 10 +++++----- user/docs/Contributing.md | 6 +++--- user/docs/Documentation.md | 20 ++++++++++---------- user/docs/NCEI.md | 6 +++--- 4 files changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 96c910d..032015d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

- +
Nautical

@@ -24,15 +24,15 @@ Peer into that spyglass and review the [nautical documentation](https://barbacbd # Documentation -View the [documentation](user/docs/Documentation.md) page for more information. +View the [documentation](https://github.com/barbacbd/nautical/blob/master/user/docs/Documentation.md) page for more information. # Contributing -View the [contirbuting guidelines](user/docs/Contributing.md) for more information. +View the [contirbuting guidelines](https://github.com/barbacbd/nautical/blob/master/user/docs/Contributing.md) for more information. # Examples -More details and specific examples can be found in [here](user/docs). +More details and specific examples can be found in [here](https://github.com/barbacbd/nautical/blob/master/user/docs/). # Building and Testing @@ -73,7 +73,7 @@ If you wish to view the results with a bit more information, run the following c pip install pytest coverage pytest-cov mock ``` -All tests for the project are located in the [tests](./tests) directory. +All tests for the project are located in the [tests](https://github.com/barbacbd/nautical/blob/master/tests) directory. The minimal requirements for the contributions to make it into the repository will be to pass all tests. Run the `pytest` command in this directory, or provide the directory to the command. Use the `coverage and pytest-cov` packages to view all of the results more clearly. diff --git a/user/docs/Contributing.md b/user/docs/Contributing.md index fa50ed0..566f159 100644 --- a/user/docs/Contributing.md +++ b/user/docs/Contributing.md @@ -7,9 +7,9 @@ development progress of the package. ## Casting off - Fork the repository on GitHub -- Read the [README](../../README.md) for test instructions. +- Read the [README](https://github.com/barbacbd/nautical/blob/master/README.md) for test instructions. - Create a virtual environment [Optional]. -- Install the build dependencies, see [building and testing](../../README.md). +- Install the build dependencies, see [building and testing](https://github.com/barbacbd/nautical/blob/master/README.md). - Play with the project, submit bugs, submit patches! ## Contribution Flow @@ -50,7 +50,7 @@ _It is suggested (but not required to add the Issue number to the commit message ## Further Information -Please run the tests [here](../../scripts/). If you cannot execute a shell script, run the equivalent on your system. +Please run the tests [here](https://github.com/barbacbd/nautical/blob/master/scripts). If you cannot execute a shell script, run the equivalent on your system. The following script executes all project tests. diff --git a/user/docs/Documentation.md b/user/docs/Documentation.md index faad5c8..ab86ef5 100644 --- a/user/docs/Documentation.md +++ b/user/docs/Documentation.md @@ -21,16 +21,16 @@ chmod 777 auto_doc.sh; # Cache -[Nautical cache](../../nautical/cache/) can be used to cache/save information to the system, so that the data can be loaded +[Nautical cache](https://github.com/barbacbd/nautical/blob/master/nautical/cache) can be used to cache/save information to the system, so that the data can be loaded back later. The file location is determined via the [appdirs module](https://pypi.org/project/appdirs/). The user can: - Create cache files - Copy cache files to new names (with timestamps or custom names) - Load Cache files to Nautical Objects. -**Note**: _Always call [setup](../../nautical/cache/file.py#L35) before using cache_. +**Note**: _Always call [setup](https://github.com/barbacbd/nautical/blob/master/nautical/cache/file.py#L35) before using cache_. -**Note**: _[Nautical cache](../../nautical/cache/) was added in version 3.1.0_. +**Note**: _[Nautical cache](https://github.com/barbacbd/nautical/blob/master/nautical/cache/) was added in version 3.1.0_. # Examples @@ -38,7 +38,7 @@ The following are examples that can be copied and modified for a user's specific ## IO -The following sections are provided as examples in the [IO module](../../nautical/io/). +The following sections are provided as examples in the [IO module](https://github.com/barbacbd/nautical/blob/master/nautical/io/). ### Buoys If you know the ID of the buoy station you may use `create_buoy` as a shortcut to create a buoy object. @@ -69,7 +69,7 @@ fill_buoy(buoy) ``` If the user wishes to view all data inside of a buoy they can iterate over the object. All -of the available variables can be found [here](../../nautical/noaa/buoy/buoy_data.py) in the +of the available variables can be found [here](https://github.com/barbacbd/nautical/blob/master/nautical/noaa/buoy/buoy_data.py) in the `buoy_vars` list.. ```python @@ -139,7 +139,7 @@ In the event that a source has _no valid buoys_, the source will *not* be return ## Location -The following sections are provided as examples in the [location module](../../nautical/location/). +The following sections are provided as examples in the [location module](https://github.com/barbacbd/nautical/blob/master/nautical/location/). ### In area @@ -217,7 +217,7 @@ if point_1.in_range(point_2, 1000.0): ## Cache -The following sections are provided as examples in the [cache module](../../nautical/cache/). +The following sections are provided as examples in the [cache module](https://github.com/barbacbd/nautical/blob/master/nautical/cache/). ### Dump data to file @@ -279,7 +279,7 @@ The following keys are allowed: - "BUOYS" - "SOURCES" -**Note**: _See the [CacheData enumeration](../../nautical/cache/file.py#l25) for more information_. +**Note**: _See the [CacheData enumeration](https://github.com/barbacbd/nautical/blob/master/nautical/cache/file.py#l25) for more information_. ```python cache_data = { @@ -296,7 +296,7 @@ dumps(tmp_data) ### Load data from file -Loading the cached data will supply the user/caller with a dictionary where the keys can be fouund in the [CacheData enumeration](../../nautical/cache/file.py#l25). +Loading the cached data will supply the user/caller with a dictionary where the keys can be fouund in the [CacheData enumeration](https://github.com/barbacbd/nautical/blob/master/nautical/cache/file.py#l25). ```python from nautical.cache import load @@ -304,7 +304,7 @@ from nautical.cache import load cache_data = load() ``` -The [load function](../../nautical/cache/file.py#l73) accepts a filename and type of data to be returned. +The [load function](https://github.com/barbacbd/nautical/blob/master/nautical/cache/file.py#l73) accepts a filename and type of data to be returned. **Note**: _Default filename is the `nautical_cache.json`_. **Note**: _Default returned data is `CacheData.ALL`_. diff --git a/user/docs/NCEI.md b/user/docs/NCEI.md index be3d6df..e28331e 100644 --- a/user/docs/NCEI.md +++ b/user/docs/NCEI.md @@ -1,6 +1,6 @@ # NOAA National Centers for Environmental Information -The NCEI module was added to version 2.3.0 found [here](../../nautical.noaa.ncei). The module adds a NOAA-managed [API](https://www.ncei.noaa.gov/) that provides users environmental information. +The NCEI module was added to version 2.3.0 found [here](https://github.com/barbacbd/nautical/blob/master/nautical.noaa.ncei). The module adds a NOAA-managed [API](https://www.ncei.noaa.gov/) that provides users environmental information. Further reading about the API information can be found [here](https://www.ncdc.noaa.gov/cdo-web/webservices/v2#gettingStarted). A token is required to access the information provided by the API, and tokens are limitted to 5 requests per second or 10,000 per day. A default token has been provided with this package, but @@ -79,7 +79,7 @@ results = query_base(get_default_token(), final_endpoint, obj_type, limit=1, off ``` In the snippet above, the user sets the specific parameters for the endpoint. The parameters for each endpoint can be -found in the files containing the [classes](../../nautical/noaa/ncei/). +found in the files containing the [classes](https://github.com/barbacbd/nautical/blob/master/nautical/noaa/ncei/). ## Query - All @@ -102,4 +102,4 @@ obj_type = Data results = query_all(get_default_token(), obj_type, parameters) ``` -The parameters for each endpoint can be found in the files containing the [classes](../../nautical/noaa/ncei/). +The parameters for each endpoint can be found in the files containing the [classes](https://github.com/barbacbd/nautical/blob/master/nautical/noaa/ncei/).