Metadata-Version: 2.1
Name: nbscuid
Version: 0.0.6
Summary: Notebook-Based, Super CUstomizable Infrastructure for Diagnostics
Author-email: Elena Romashkova <eromashkova@ucar.edu>
License: Copyright (c) 2018 The Python Packaging Authority
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: repository, https://github.com/rmshkv/nbscuid
Project-URL: documentation, https://nbscuid.readthedocs.io
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE

# nbscuid 🦑

### Notebook-Based, Super CUstomizable Infrastructure for Diagnostics

This is a package to enable running notebook-based diagnostic workflows. Based on my-cesm-experiment by matt-long: https://github.com/matt-long/my-cesm-experiment. 

See some examples of workflows at https://github.com/rmshkv/nbscuid-examples.

## Capabilities

- Integration with data catalogs
- Inject custom parameters into code and Markdown cells
- Run many notebooks at once on a parameter set, or different parameters per notebook
- Run different notebooks in different environments
- Cache intermediate data products
- Quickly build a Jupyter book with results


## Installation

1. Clone this repo

2. Activate the environment you want to install `nbscuid` in. Within the cloned `nbscuid` directory, run:
    ```
    pip install .
    ```
    Alternatively, to install the commands `nbscuid-run` and `nbscuid-build` without installing all of `nbscuid`'s dependencies, first install `pipx` with `pip install pipx`, then run:
    ```
    pipx install .
    ```

## Running a notebook collection

Create a new folder that contains a `config.yml` file. (A guide to what goes in a `config.yml` file is coming soon!) This will be the run directory for your collection of notebooks, where all the computed notebooks will appear.

To run all the notebooks you've specified, execute:

```
nbscuid-run path/to/config.yml
```


To build the jupyter book if desired, execute:

```
nbscuid-build path/to/config.yml
```



