Getting Started with nova_ec

This guide will help you install, configure, and start using the nova_ec package.

Installation

Clone the repository:

git clone https://github.com/your-organization/nova_ec.git
cd nova_ec

Create and activate a virtual environment:

# Using venv
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Using conda
conda create -n nova_ec python=3.10
conda activate nova_ec

Install the package in development mode:
```
pip install -e .
```

Basic Usage

The package provides a command-line interface for running the complete pipeline:

nova-ec --config your_config.yaml --stages all

You can also run specific stages:

# Just run the data retrieval stage
nova-ec --config your_config.yaml --stages retrieve

# Just run the analysis stage with a specific solar systems file
nova-ec --config your_config.yaml --stages analyze --solar-systems-file path/to/file.csv

Python API

You can also use the package as a Python library:

from nova_ec.config import load_config
from nova_ec.matching import integrated_matching
from nova_ec.data import process_solar_systems

# Load configuration
config = load_config("config.yaml")

# Process solar systems data
solar_systems_df = process_solar_systems("path/to/systems.csv", date_cols, systems_cols)

# Perform matching
results = integrated_matching(solar_systems_df, ccec_data, ffsa_data)

Next Steps

See the Configuration page for details on setting up your config file
Check out the Tutorial for more advanced usage
Explore the API Reference for detailed documentation of all modules