Skip to content

Commit

Permalink
Merge pull request #43 from ColCarroll/update-refs
Browse files Browse the repository at this point in the history
Update references from "master" to "main"
  • Loading branch information
ColCarroll authored Apr 3, 2024
2 parents e67f1e0 + 41e3883 commit 170df86
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ Or live on the edge and install from github with
pip install git+https://github.com/colcarroll/ridge_map.git
```

You can also make a copy of [this colab](https://colab.research.google.com/drive/1ntwd73haePt3OS5ysz4yGSlhmUecY24O?usp=sharing).

Want to help?
-------------

Expand All @@ -46,7 +48,7 @@ from ridge_map import RidgeMap
RidgeMap().plot_map()
```

![png](https://github.com/ColCarroll/ridge_map/blob/master/examples/white_mountains.png?raw=true)
![png](https://github.com/ColCarroll/ridge_map/blob/main/examples/white_mountains.png?raw=true)

### Download once and tweak settings

Expand All @@ -71,7 +73,7 @@ rm.plot_map(values=values,
linewidth=1)
```

![png](https://github.com/ColCarroll/ridge_map/blob/master/examples/karwendelgebirge.png?raw=true)
![png](https://github.com/ColCarroll/ridge_map/blob/main/examples/karwendelgebirge.png?raw=true)

### Plot with colors!

Expand All @@ -88,7 +90,7 @@ rm.plot_map(values=rm.preprocess(values=values, water_ntile=12, vertical_ratio=4
line_color='orange')
```

![png](https://github.com/ColCarroll/ridge_map/blob/master/examples/austin.png?raw=true)
![png](https://github.com/ColCarroll/ridge_map/blob/main/examples/austin.png?raw=true)

### Plot with even more colors!

Expand All @@ -103,7 +105,7 @@ rm.plot_map(values=rm.preprocess(values=values, lake_flatness=3, water_ntile=50,
line_color = plt.get_cmap('spring'))
```

![png](https://github.com/ColCarroll/ridge_map/blob/master/examples/san_francisco.png?raw=true)
![png](https://github.com/ColCarroll/ridge_map/blob/main/examples/san_francisco.png?raw=true)

### Plot with custom fonts and elevation colors!

Expand All @@ -128,7 +130,7 @@ rm.plot_map(values=rm.preprocess(values=values, lake_flatness=2, water_ntile=10,
kind='elevation')
```

![png](https://github.com/ColCarroll/ridge_map/blob/master/examples/hawaii.png?raw=true)
![png](https://github.com/ColCarroll/ridge_map/blob/main/examples/hawaii.png?raw=true)

### How do I find a bounding box?

Expand All @@ -144,7 +146,7 @@ rm.plot_map(values=rm.preprocess(values=values, lake_flatness=2, water_ntile=2,
label_size=40)
```

![png](https://github.com/ColCarroll/ridge_map/blob/master/examples/kent.png?raw=true)
![png](https://github.com/ColCarroll/ridge_map/blob/main/examples/kent.png?raw=true)

### What about really flat areas?

Expand All @@ -160,7 +162,7 @@ rm.plot_map(values=rm.preprocess(values=values, lake_flatness=4, water_ntile=30,
linewidth=1)
```

![png](https://github.com/ColCarroll/ridge_map/blob/master/examples/boston.png?raw=true)
![png](https://github.com/ColCarroll/ridge_map/blob/main/examples/boston.png?raw=true)

### What about Walden Pond?

Expand All @@ -175,7 +177,7 @@ rm.plot_map(values=rm.preprocess(values=values, water_ntile=15, vertical_ratio=3
label_size=30)
```

![png](https://github.com/ColCarroll/ridge_map/blob/master/examples/concord.png?raw=true)
![png](https://github.com/ColCarroll/ridge_map/blob/main/examples/concord.png?raw=true)

### Do you play nicely with other matplotlib figures?

Expand All @@ -193,7 +195,7 @@ rm = RidgeMap()
rm.plot_map(label_size=24, background_color=(1, 1, 1), ax=axes[1])
```

![png](https://github.com/ColCarroll/ridge_map/blob/master/examples/multiaxis.png?raw=true)
![png](https://github.com/ColCarroll/ridge_map/blob/main/examples/multiaxis.png?raw=true)

User Examples
-------------
Expand Down Expand Up @@ -249,7 +251,7 @@ ridges.plot(*scipp_coords, 'o',
zorder=len(values)+10)
```

![png](https://github.com/ColCarroll/ridge_map/blob/master/examples/santa_cruz.png?raw=true)
![png](https://github.com/ColCarroll/ridge_map/blob/main/examples/santa_cruz.png?raw=true)

Elevation Data
--------------
Expand Down

0 comments on commit 170df86

Please sign in to comment.