Skip to content

Commit

Permalink
Updated References.
Browse files Browse the repository at this point in the history
  • Loading branch information
barbacbd committed Jul 16, 2022
1 parent c08305f commit c5ec7fc
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 21 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<h1 align="center">
<a href="https://github.com/barbacbd/nautical">
<img src="https://github.com/barbacbd/nautical/blob/231d553500087cf23348aa80b830cf842f9edd1e/.images/buoy.jpg" width="256" height="256" border-radius="50%" >
<img src="https://raw.githubusercontent.com/barbacbd/nautical/master/.images/buoy.jpg" width="256" height="256" border-radius="50%" >
</a>
<br>Nautical</br>
</h1>
Expand All @@ -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

Expand Down Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions user/docs/Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.

Expand Down
20 changes: 10 additions & 10 deletions user/docs/Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,24 +21,24 @@ 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

The following are examples that can be copied and modified for a user's specific needs.

## 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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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 = {
Expand All @@ -296,15 +296,15 @@ 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

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`_.
Expand Down
6 changes: 3 additions & 3 deletions user/docs/NCEI.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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

Expand 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/).

0 comments on commit c5ec7fc

Please sign in to comment.