Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added

- Documentation in docs/ hosted at brews.github.io/isku.
- Documentation in docs/ hosted at https://climateimpactlab.github.io/isku.
- Test and test-coverage badges to README.
- Add pre-commit hooks (via prek) to help developers with format.

### Changed

- Move project repository to https://github.com/climateimpactlab/isku. They own this now.
- BREAKING: `isku.ExtractionWorkflow` is now `isku.ExtractionTemplate`.
- BREAKING: `isku.ProjectionWorkflow` is now `isku.ProjectionTemplate`.
- BREAKING: `isku.build_extraction_workflow` is now `isku.build_extraction_template`.
Expand All @@ -29,5 +30,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- Initial release.

[Unreleased]: https://github.com/brews/isku/compare/v0.1.0...HEAD
[0.1.0]: https://github.com/brews/isku/releases/tag/v0.1.0
[Unreleased]: https://github.com/climateimpactlab/isku/compare/v0.1.0...HEAD
[0.1.0]: https://github.com/climateimpactlab/isku/releases/tag/v0.1.0
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ You can contribute in many ways:

### Report Bugs

Report bugs at https://github.com/brews/isku/issues
Report bugs at https://github.com/climateimpactlab/isku/issues

If you are reporting a bug, please include:

Expand All @@ -35,7 +35,7 @@ PRs with small corrections to spelling, format or clarity are welcome. The proje

### Submit Feedback

The best way to send feedback is to file an issue at https://github.com/brews/isku/issues.
The best way to send feedback is to file an issue at https://github.com/climateimpactlab/isku/issues.

If you are proposing a new feature:

Expand Down Expand Up @@ -110,7 +110,7 @@ git push origin name-of-your-bugfix-or-feature

## Documentation

Documentation is in the `docs/` directory with global configurations in the `.zensical` file. Documentation is rendered with [Zensical](https://zensical.org/) and hosted through GitHub Pages to https://brews.github.io/isku/.
Documentation is in the `docs/` directory with global configurations in the `.zensical` file. Documentation is rendered with [Zensical](https://zensical.org/) and hosted through GitHub Pages to https://climateimpactlab.github.io/isku/.

You can build and check any changes or additions you've made to documentation locally on your machine after you've set up your development environment.

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# isku

[![python-test](https://github.com/brews/isku/actions/workflows/python-test.yaml/badge.svg)](https://github.com/brews/isku/actions/workflows/python-test.yaml)
[![codecov](https://codecov.io/gh/brews/isku/graph/badge.svg?token=G53WDRL97C)](https://codecov.io/gh/brews/isku)
[![Documentation](https://github.com/brews/isku/actions/workflows/docs.yml/badge.svg)](https://github.com/brews/isku/actions/workflows/docs.yml)
[![python-test](https://github.com/climateimpactlab/isku/actions/workflows/python-test.yaml/badge.svg)](https://github.com/climateimpactlab/isku/actions/workflows/python-test.yaml)
[![codecov](https://codecov.io/gh/climateimpactlab/isku/graph/badge.svg?token=G53WDRL97C)](https://codecov.io/gh/climateimpactlab/isku)
[![Documentation](https://github.com/climateimpactlab/isku/actions/workflows/docs.yml/badge.svg)](https://github.com/climateimpactlab/isku/actions/workflows/docs.yml)

Minimalist Python + Xarray-based climate impact projection framework for researchers with little time.

Expand Down Expand Up @@ -162,13 +162,13 @@ uv add isku
Install the unreleased and unstable bleeding-edge version of the package with:

```shell
pip install git+https://github.com/brews/isku
pip install git+https://github.com/climateimpactlab/isku
```

using `pip` or with a project in `uv`, do

```shell
uv add git+https://github.com/brews/isku
uv add git+https://github.com/climateimpactlab/isku
```

## Is this any good?
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ uv add isku
Install the unreleased and unstable bleeding-edge version of the package with:

```shell
pip install git+https://github.com/brews/isku
pip install git+https://github.com/climateimpactlab/isku
```

using `pip` or with a project in `uv`, do

```shell
uv add git+https://github.com/brews/isku
uv add git+https://github.com/climateimpactlab/isku
```
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ readme = "README.md"
authors = [{ name = "Brewster Malevich", email = "bmalevich@rhg.com" }]
requires-python = ">=3.14"
dependencies = ["xarray>=2026.4.0"]
urls = { Repository = "https://github.com/brews/isku", Documentation = "https://brews.github.io/isku" }
urls = { Repository = "https://github.com/climateimpactlab/isku", Documentation = "https://climateimpactlab.github.io/isku" }

[build-system]
requires = ["uv_build>=0.11.12,<0.12.0"]
Expand Down
14 changes: 7 additions & 7 deletions zensical.toml
Original file line number Diff line number Diff line change
Expand Up @@ -22,20 +22,20 @@ site_description = "Minimalist Python + xarray-based climate impact projection f
# The site_author attribute. This is used in the HTML head element.
#
# Read more: https://zensical.org/docs/setup/basics/#site_author
site_author = "@brews"
site_author = "@climateimpactlab"

# The site_url is the canonical URL for your site. When building online
# documentation you should set this.
# Read more: https://zensical.org/docs/setup/basics/#site_url
site_url = "https://brews.github.io/isku"
site_url = "https://climateimpactlab.github.io/isku"

# The copyright notice appears in the page footer and can contain an HTML
# fragment.
#
# Read more: https://zensical.org/docs/setup/basics/#copyright
copyright = """
Copyright &copy; 2026 Steven B. Malevich
"""
# copyright = """
# Copyright &copy; 2026 Your Name Here
# """

# Zensical supports both implicit navigation and explicitly defined navigation.
# If you decide not to define a navigation here then Zensical will simply
Expand Down Expand Up @@ -71,8 +71,8 @@ extra_javascript = [
"https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js"
]

repo_name = "brews/isku"
repo_url = "https://github.com/brews/isku"
repo_name = "climateimpactlab/isku"
repo_url = "https://github.com/climateimpactlab/isku"
edit_uri = "edit/main/docs/"

[project.validation]
Expand Down
Loading