| CI |     |
|---|---|
| License |  |
| Docs |
A scalable platform for analyzing and visualizing climate-related risks at a building-level resolution across the Continental United States (CONUS)
Important
We use pixi to manage our development environment, which you'll need to install before you can get started with the project.
# Clone the repository
git clone https://github.com/carbonplan/ocr.git
cd ocr
# Install dependencies with pixi
pixi install
# Activate the environment
pixi shell# Run all tests
pixi run tests
# Run specific test file
pixi run pytest tests/test_datasets.py
# Run integration tests
pixi run tests-integration# Format code
pixi run format
# Run linting
pixi run lintWe welcome contributions! Please see our contributing guide for detailed instructions on:
-
Setting up your development environment
-
Running tests and quality checks
-
Submitting pull requests
-
Documentation - Full documentation
-
Issues - Report bugs or request features via GitHub Issues
-
Discussions - Join the conversation in GitHub Discussions
Our processed input datasets and pipeline outputs can be accessed on Source Coop. Details on how to use the data can be found in our technical documentation.
Important
Our codebase and technical documentation make frequent reference to our data catalog, which relies on privately hosted data. Operationalizing our codebase without access to these data will currently require an update to the catalog. See #367 for more detail.
Important
OCR code is licensed under the MIT License - see the LICENSE file for details. See the data access page for information on the licenses for the various datasets.