Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hesspnnl committed Jan 28, 2025
1 parent 85bf4de commit c276a01
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
A library designed to simplify various research tasks for users looking to leverage the NMDC (National Microbiome Data Collaborative) APIs. The library provides a collection of general-purpose functions that facilitate easy access, manipulation, and analysis of microbiome data.

# Usage
Until this available through pip, the best usage will be to clone the repo and use like this example:
Example use of the Biosample class:
```python
from nmdc_notebook_tools.biosample_search import BiosampleSearch

Expand All @@ -11,7 +11,6 @@ biosample_client = BiosampleSearch()
# Use the variable to call the available functions
biosample_client.get_collection_by_id("biosample", "id")
```
I would recommend periodically runnning `git pull` to get the latest updates.

## Logging - Debug Mode
To see debugging information, include these two lines where ever you are running the functions:
Expand All @@ -23,7 +22,17 @@ biosample_client.get_collection_by_id("biosample", "id")
```

# Installation
Note: nmdc_notebook_tools will eventually be available at `pip install nmdc_notebook_tools` but is still in development.
To install, run:

```bash
python3 -m pip install nmdc_notebook_tool
```

Peridodically run
```bash
python3 -m pip install --upgrade nmdc_notebook_tools
```
to ensure you have the latest updates from this package.

# Documentation
Documentation about available functions and helpful usage notes can be found at https://microbiomedata.github.io/nmdc_notebook_tools/.

0 comments on commit c276a01

Please sign in to comment.