Skip to content

Commit d2739f9

Browse files
committed
Revamped readme
1 parent dd8eed4 commit d2739f9

File tree

1 file changed

+23
-10
lines changed

1 file changed

+23
-10
lines changed

README.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@
88
[![License](https://img.shields.io/github/license/amanchokshi/EMBERS?label-License&color=b72c40&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAdCAYAAADLnm6HAAAACXBIWXMAAB2HAAAdhwGP5fFlAAAAGXRFWHRTb2Z0d2FyZQB3d3cuaW5rc2NhcGUub3Jnm+48GgAAAflJREFUSIntljFrVUEQhb95CViYCGItGLSIIIJiISadYiOIAS0stFAEK0G0DQRs8wOs7PQvqCC2kjQJaiEICoJYaZMYzCP6WWSfLs97c/deQtJ4YODu7syZs7N7l4GOUCfVj8kmu/L0ugYCM8ChZDO7IWBPzfeOCdg5qD31urqs9q1HX11Sr6nbszl1Wl3cImkdFtXpNonm1fUOidpiXZ2vErDaELimPlDHk/9ctjaX5saTz1oD1+ogb35OD4F+RXG+Ao+AoxExGxErdVWMiJWImAUmU8y3Crd+ylV5DD31fab0gzpS4/tPBbrwDd/US8CRbDwBXKxUW4ZGvmEB9ypIquZK0cj3R4B6GjiThuvJAKbSWiuU8uUVuJ99Pwae1KkuRDmfOqFuZJfluHpM/ZXGG+rhoZjaS9iGb1CBu8Dgdj6NiNcR8RZ4nuZGgDstdl/Op+5XVzK1Z7OdnMsfD/VAUwXa8vWA28BY8nkDvBwERMQLYDkN9wK3Cnbfiq8H3MiCPwEn1H3JTgKfs/WbBQJa8Y3y9/cAuJCsDj8KBLTi6wGXgYUC4gXgSoFfK77RiHinTgHngavAKeAgMAp8AV6x+Q8/i4ifTazbzVeLrd6BNtj1nvC/gEbYvVes7v2GEAUCVtl8tbrge0SMbeVQcgR1vWIT6nu/DL8BDHb5/EeYsAMAAAAASUVORK5CYII=)](https://github.com/amanchokshi/solshade/blob/main/LICENSE)
99
[![Black](https://img.shields.io/badge/Code%20Style-Black-222222.svg?logo=powershell&logoColor=white)](https://black.readthedocs.io)
1010
---
11-
`solshade` is a Python toolkit for simulating solar radiation across landscapes, accounting for terrain shadows, solar angles, and orbital geometry. It’s designed for interdisciplinary research at the intersection of astronomy, glaciology, botany, and geology.
11+
`solshade` is a Python toolkit for simulating solar radiation across
12+
landscapes, accounting for terrain shadows, solar angles, and orbital geometry.
13+
It’s designed for interdisciplinary research at the intersection of astronomy,
14+
glaciology, botany, and geology. Capturing the dance of *sol* (Sun) and *shade*
15+
(Shadow) over landscapes.
1216

1317
---
1418

@@ -25,19 +29,26 @@
2529

2630
---
2731

32+
`solshade` is designed to install cleanly with a single invocation of the standard Python package tool:
33+
34+
```
35+
pip install solshade
36+
```
37+
38+
Here are some essential project links:
39+
40+
- [Home page and documentation](https://solshade.readthedocs.io/en/latest)
41+
- [Installing solshade](https://solshade.readthedocs.io/en/latest/guides/install)
42+
- [Getting started with solshade](https://solshade.readthedocs.io/en/latest/guides)
43+
- [solshade package](https://pypi.org/project/solshade) on the Python Package Index
44+
- [Issue tracker on github](https://github.com/amanchokshi/solshade/issues)
45+
2846
## Example Applications
2947

30-
- Modeling plant growing seasons across topography
3148
- Studying microhabitats in extreme environments
3249
- Predicting snowmelt timing in complex terrain
3350
- Understanding glacial melt and shadowed regions
34-
35-
---
36-
37-
## Project Status
38-
39-
This project is in early development.
40-
Expect breaking changes, experiments, and rapid iteration.
51+
- Modeling plant growing seasons across topography
4152

4253
---
4354

@@ -49,4 +60,6 @@ MIT License — see `LICENSE` file.
4960

5061
## Acknowledgments
5162

52-
Inspired by many interesting conversations with Anna O'Flynn, Anthony Zerafa & Chris Omelon at the McGill Arctic Research Station (MARS) on Axel Heiberg Island, 2025.
63+
Inspired by many interesting conversations with Anna O'Flynn, Anthony Zerafa
64+
& Chris Omelon at the McGill Arctic Research Station (MARS) on Axel Heiberg
65+
Island, 2025.

0 commit comments

Comments
 (0)