Skip to content

Commit

Permalink
Update README.md (#83)
Browse files Browse the repository at this point in the history
* Update README.md

@ocefpaf mind taking a look?

It's confusing that the git repo is `ioos_metrics` but conda is `ioos-metrics`. Is it too late to adjust that?

* Update README.md

Co-authored-by: Filipe <[email protected]>

---------

Co-authored-by: Filipe <[email protected]>
  • Loading branch information
MathewBiddle and ocefpaf authored Jun 7, 2024
1 parent 4cfe9d2 commit e220bb5
Showing 1 changed file with 28 additions and 4 deletions.
32 changes: 28 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,35 @@
# ioos_by_the_numbers
Working on creating metrics for the [IOOS by the numbers](https://ioos.noaa.gov/about/ioos-by-the-numbers/)
# ioos-metrics

Requirements:
A library to compute and compile metrics about the U.S. Integrated Ocean Observing System (U.S. IOOS®). U.S. IOOS® is a vital tool for tracking, predicting, managing, and adapting to changes in our ocean, coastal and Great Lakes environment.

Creating metrics for the [IOOS by the numbers](https://ioos.noaa.gov/about/ioos-by-the-numbers/).

"IOOS by the Numbers" is was developed as a graphical representation of IOOS -- a system of includes our partnerships, research and observing components, and data management capabilities.
This figure is an annually updated collection of numbers that show the breadth of the IOOS Program as it is growing and evolving.
These data were obtained from multiple sources in July 2022. The original source for each value is identified below.
Links to each federal partner or regional association are provided.

## Installation instructions:

### conda
```
conda install ioos-metrics
```

### pip
```
pip install ioos-metrics
```

## Usage

See <https://github.com/ioos/ioos_metrics/tree/main/notebooks>

## Website
Leveraged existing resources from https://github.com/noaa-fisheries-integrated-toolbox/toolbox_web_templating.

url: <https://ioos.github.io/ioos_metrics/>

Leveraged existing resources from <https://github.com/noaa-fisheries-integrated-toolbox/toolbox_web_templating>.

The webpages are built from the `website/` directory.

Expand Down

0 comments on commit e220bb5

Please sign in to comment.