Skip to content

Commit

Permalink
add missing images
Browse files Browse the repository at this point in the history
  • Loading branch information
MAfarrag committed Jan 15, 2025
1 parent de41e46 commit 002dfa9
Show file tree
Hide file tree
Showing 14 changed files with 15 additions and 48 deletions.
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ repos:
args: [ --markdown-linebreak-ext=md ]
- id: check-added-large-files
name: "[file - check] large file"
args: [ --maxkb=2000 ]
args: [ --maxkb=3000 ]
- id: check-docstring-first
name: "[py - check] docstring first"
files: /examples
Expand Down
8 changes: 5 additions & 3 deletions docs/data-visualization/digital-earth.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,10 @@ from digitalearth.map import Map
src = gdal.Open("examples/data/acc4000.tif")
fig, ax = Map.plot(src, title="Flow Accumulation", cbar_label="Flow Accumulation")
```
![Flowaccumulation](examples/images/flow_accumulation.png)
```
![Flowaccumulation](/docs/images/digital-earth/flow_accumulation.png)
```python
import pandas as pd
from digitalearth.map import Map
points = pd.read_csv("examples/data/points.csv")
point_color = "blue"
point_size = 100
Expand All @@ -98,5 +100,5 @@ fig, ax = Map.plot(
cbar_label="Flow Accumulation"
)
```
![Flowaccumulation](examples/images/flow_accumulation_with_labels.png)
![Flowaccumulation](/docs/images/digital-earth/flow_accumulation_with_labels.png)
[other code samples](https://digitalearth.readthedocs.io/en/latest/?badge=latest)
14 changes: 0 additions & 14 deletions docs/gis/digital-rivers.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,6 @@ digitalrivers - GIS utility package
=====================================================================
**digitalrivers** is a GIS utility package using gdal, ....

digitalrivers

![1](/docs/images/package-work-flow/overall.png)

Main Features
-------------

- GIS modules to enable the modeler to fully prepare the meteorological inputs and do all the preprocessing
needed to build the model (align rasters with the DEM), in addition to various methods to manipulate and
convert different forms of distributed data (rasters, NetCDF, shapefiles)

Future work
-------------
Expand Down Expand Up @@ -79,7 +69,3 @@ Quick start
```

[other code samples](https://digitalrivers.readthedocs.io/en/latest/?badge=latest)

## Coverage

[![codecov](https://codecov.io/gh/Serapieum-of-alex/digitalrivers/branch/main/graphs/sunburst.svg?token=g0DV4dCa8N)](https://codecov.io/gh/Serapieum-of-alex/digitalrivers)
2 changes: 1 addition & 1 deletion docs/gis/pyramids.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ pyramids - GIS utility package

pyramids

![1](/docs/source/_images/package-work-flow/overall.png)
![1](/docs/images/pyramids/overall.png)

Main Features
-------------
Expand Down
13 changes: 2 additions & 11 deletions docs/hydrological-modeling/hapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,10 @@ Current build status
![GitHub last commit](https://img.shields.io/github/last-commit/MAfarrag/Hapi)
![GitHub forks](https://img.shields.io/github/forks/MAfarrag/hapi?style=social)
![GitHub Repo stars](https://img.shields.io/github/stars/MAfarrag/Hapi?style=social)
![AppVeyor tests (branch)](https://img.shields.io/appveyor/tests/MAfarrag/Ha%5Bi/hydraulic-model)


[![Github all releases](https://img.shields.io/github/downloads/Naereen/StrapDown.js/total.svg)](https://GitHub.com/Naereen/StrapDown.js/releases/)

![Profile views](https://gpvc.arturio.dev/MAfarrag)


Current release info
====================
Expand All @@ -44,7 +41,7 @@ Current release info
| [![Conda Recipe](https://img.shields.io/badge/recipe-hapi-green.svg)](https://anaconda.org/conda-forge/hapi) | [![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/hapi.svg)](https://anaconda.org/conda-forge/hapi) [![Downloads](https://pepy.tech/badge/hapi-nile)](https://pepy.tech/project/hapi-nile) [![Downloads](https://pepy.tech/badge/hapi-nile/month)](https://pepy.tech/project/hapi-nile) [![Downloads](https://pepy.tech/badge/hapi-nile/week)](https://pepy.tech/project/hapi-nile) ![PyPI - Downloads](https://img.shields.io/pypi/dd/hapi-nile?color=blue&style=flat-square) ![GitHub all releases](https://img.shields.io/github/downloads/MAfarrag/Hapi/total) | [![Conda Version](https://img.shields.io/conda/vn/conda-forge/hapi.svg)](https://anaconda.org/conda-forge/hapi) [![PyPI version](https://badge.fury.io/py/HAPI-Nile.svg)](https://badge.fury.io/py/HAPI-Nile) [![Anaconda-Server Badge](https://anaconda.org/conda-forge/hapi/badges/version.svg)](https://anaconda.org/conda-forge/hapi) | [![Conda Platforms](https://img.shields.io/conda/pn/conda-forge/hapi.svg)](https://anaconda.org/conda-forge/hapi) [![Join the chat at https://gitter.im/Hapi-Nile/Hapi](https://badges.gitter.im/Hapi-Nile/Hapi.svg)](https://gitter.im/Hapi-Nile/Hapi?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |


![Hapi](/docs/img/Hapi4.png) ![Hapi](/docs/img/name.png)
![Hapi](/docs/images/hapi/Hapi4.png) ![Hapi](/docs/images/hapi/name.png)


Hapi - Hydrological library for Python
Expand All @@ -54,7 +51,7 @@ model & Muskingum routing method at a catchment scale (Farrag & Corzo, 2021), Ha
(spatial discretization - cell size, temporal resolution, parameterization approaches and calibration (Farrag et al., 2021)).


![1](/docs/img/Picture1.png) ![2](/docs/img/Picture2.png)
![1](/docs/images/hapi/Picture1.png) ![2](/docs/images/hapi/Picture2.png)

Hapi

Expand Down Expand Up @@ -137,9 +134,3 @@ Quick start
```

[other code samples](https://hapi-hm.readthedocs.io/en/latest/?badge=latest)

## Naming Convention
[PEP8](https://peps.python.org/pep-0008/#naming-conventions)
- module names: lower case word, preferably one word if not, separate words with underscores (module.py, my_module.py).
- class names: PascalCase (Model, MyClass).
- class method/function: CamelCase(getFile, readConfig).should have a verb one them, because they perform some action
19 changes: 3 additions & 16 deletions docs/hydrological-modeling/serapis.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,19 +40,12 @@ Current release info
| [![Conda Recipe](https://img.shields.io/badge/recipe-serapis-green.svg)](https://anaconda.org/conda-forge/serapis) | [![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/serapis.svg)](https://anaconda.org/conda-forge/serapis) [![Downloads](https://pepy.tech/badge/serapis)](https://pepy.tech/project/serapis) [![Downloads](https://pepy.tech/badge/serapis/month)](https://pepy.tech/project/serapis) [![Downloads](https://pepy.tech/badge/serapis/week)](https://pepy.tech/project/serapis) ![PyPI - Downloads](https://img.shields.io/pypi/dd/serapis?color=blue&style=flat-square) ![GitHub all releases](https://img.shields.io/github/downloads/Serapieum-of-alex/serapis/total) | [![Conda Version](https://img.shields.io/conda/vn/conda-forge/serapis.svg)](https://anaconda.org/conda-forge/serapis) [![PyPI version](https://badge.fury.io/py/serapis.svg)](https://badge.fury.io/py/serapis) [![Anaconda-Server Badge](https://anaconda.org/conda-forge/serapis/badges/version.svg)](https://anaconda.org/conda-forge/serapis) | [![Conda Platforms](https://img.shields.io/conda/pn/conda-forge/serapis.svg)](https://anaconda.org/conda-forge/serapis) [![Join the chat at https://gitter.im/serapis/serapis](https://badges.gitter.im/serapis/serapis.svg)](https://gitter.im/serapis/serapis?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |


![serapis](/docs/img/serapis4.png) ![serapis](/docs/img/name.png)


serapis - Hydrological library for Python
serapis - hydrodynamic model library for Python
=====================================================================
**serapis** is an open-source Python Framework for building raster-based conceptual distributed hydrological models using HBV96 lumped
model & Muskingum routing method at a catchment scale (Farrag & Corzo, 2021), serapis gives a high degree of flexibility to all components of the model
(spatial discretization - cell size, temporal resolution, parameterization approaches and calibration (Farrag et al., 2021)).

**serapis** is an open-source Python Framework for building hydrodynamic models using 1D Saint-Venant equations at
a river scale.

![1](/docs/img/Picture1.png) ![2](/docs/img/Picture2.png)

serapis


Installing serapis
Expand Down Expand Up @@ -90,9 +83,3 @@ Quick start
```

[other code samples](https://serapis.readthedocs.io/en/latest/?badge=latest)

## Naming Convention
[PEP8](https://peps.python.org/pep-0008/#naming-conventions)
- module names: lower case word, preferably one word if not, separate words with underscores (module.py, my_module.py).
- class names: PascalCase (Model, MyClass).
- class method/function: CamelCase(getFile, readConfig).should have a verb one them, because they perform some action
Binary file added docs/images/digital-earth/flow_accumulation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/hapi/Hapi4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/hapi/Picture1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/hapi/Picture2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/hapi/name.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/pyramids/overall.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 3 additions & 2 deletions docs/utility-packages/oasis.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,13 @@ python setup.py install
pathto_your_env\python setup.py install
```
## pip
to install the last release you can easly use pip
to install the latest release, you can use pip
```
pip install Oasis-Optimization
```
## YML file
using the environment.yml file included with hapi you can create a new environment with all the dependencies installed with the latest Hapi version
using the environment.yml file included with the package you can create a new environment with all the dependencies
installed with the latest Hapi version
in the master branch
```
conda env create --name Hapi_env -f environment.yml
Expand Down

0 comments on commit 002dfa9

Please sign in to comment.