Skip to content

Commit 32e16b9

Browse files
authored
Update README.md
1 parent f315add commit 32e16b9

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

README.md

+16-12
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,10 @@ pip install eis_toolkit
5050
conda install -c conda-forge eis_toolkit
5151
```
5252

53-
You can find the latest release of EIS Toolkit also in the [releases page](https://github.com/GispoCoding/eis_toolkit/releases) of this GitHub repository as a Python wheel. Just download the wheel and install with pip
54-
55-
```console
56-
pip install eis_toolkit-0.4.0-py3-none-any.whl
57-
```
53+
A Python wheel can be downloaded also from the [releases page](https://github.com/GispoCoding/eis_toolkit/releases) of this GitHub repository.
5854

5955
> [!TIP]
60-
> GDAL needs to be installed separately on Windows when using pip / PyPI. If you have trouble installing EIS Toolkit in a venv due to GDAL, you can download a compatible GDAL wheel (for example from [this repository](https://github.com/cgohlke/geospatial-wheels/releases)), install it first, and then attempt to install EIS Toolkit again.
56+
> GDAL needs to be installed separately on Windows when using pip / PyPI. If you have trouble installing EIS Toolkit due to GDAL, you can download a compatible GDAL wheel (for example from [this repository](https://github.com/cgohlke/geospatial-wheels/releases)), install it first, and then attempt to install EIS Toolkit again.
6157
6258

6359
## Usage
@@ -71,7 +67,7 @@ from eis_toolkit.raster_processing.reprojecting import reproject_raster
7167
from eis_toolkit.exploratory_analyses.pca import compute_pca
7268
```
7369

74-
You can find several Jupyter notebooks in this repostiory that demonstrate how tools of EIS Toolkit can be used. The documentation of EIS Toolkit can be read [here](https://gispocoding.github.io/eis_toolkit/).
70+
The documentation of EIS Toolkit can be read [here](https://gispocoding.github.io/eis_toolkit/). You can find several Jupyter notebooks in this repostiory that demonstrate how tools of EIS Toolkit can be used.
7571

7672

7773
### EIS QGIS Plugin
@@ -80,23 +76,31 @@ For those that prefer using tools of EIS Toolkit via a graphical user interface,
8076
The plugin is developed by the same core team that develops EIS Toolkit.
8177

8278
### CLI
83-
EIS Toolkit includes a [Typer](https://typer.tiangolo.com/) command-line interface that serves as a common interface for integrating the toolkit with external applications, such as QGIS. However, it can be used directly too. To use the CLI, simply use the command
79+
EIS Toolkit includes a [Typer](https://typer.tiangolo.com/) command-line interface that serves as a common interface for integrating the toolkit with external applications, such as QGIS. The CLI can be used directly too, for example
80+
8481
```console
85-
eis
82+
eis resample-raster-cli --input-raster path/to/raster.tif --output-raster path/to/output.tif --resolution 50 --resampling-method bilinear
8683
```
8784

88-
or
85+
For general help, use
8986

9087
```console
9188
eis --help
9289
```
9390

94-
to get started. However, please note that the CLI has been primarily designed to communicate with external programs and may feel clunky in direct use.
91+
or help for a tool
92+
93+
```console
94+
eis <tool-name> --help
95+
```
96+
97+
> [!NOTE]
98+
> Please note that the CLI has been primarily designed to communicate with external programs and may be clunky in direct use.
9599
96100
## Roadmap
97101

98102
- Milestone 1: **Beta release 0.1** (November 2023). The toolkit should have the basic funtionalities required for a full MPM workflow. Official testing phase begins. The plugin will be still under active development.
99-
- Milestone 2: **Release 1.0** (April 2024). All features should be incorporated at this time and the toolkit useful for actual MPM work. Testing will continue, potential bugs will be fixed and the user experience refined.
103+
- Milestone 2: **Release 1.0** (May 2024). Most features should be incorporated at this time and the toolkit useful for actual MPM work. Testing will continue, more advanced methods added and the user experience refined.
100104

101105
## Contributing
102106

0 commit comments

Comments
 (0)