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
86 changes: 0 additions & 86 deletions README.md

This file was deleted.

1 change: 1 addition & 0 deletions README.md
87 changes: 86 additions & 1 deletion python/jupytergis/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,86 @@
# JupyterGIS meta-package
<p align="center"><img width="100" src="https://raw.githubusercontent.com/geojupyter/jupytergis/main/packages/base/style/icons/logo.svg"></p>
<h1 align="center">JupyterGIS - A JupyterLab extension for collaborative GIS</h1>

[![lite-badge]][lite] [![docs-badge]][docs]

[lite-badge]: https://jupyterlite.rtfd.io/en/latest/_static/badge.svg
[lite]: https://jupytergis.readthedocs.io/en/latest/lite/lab/index.html?path=france_hiking.jGIS/
[docs-badge]: https://readthedocs.org/projects/jupytergis/badge/?version=latest
[docs]: https://jupytergis.readthedocs.io

⚠️ This extension is work in progress. Features and APIs are subject to change quickly. ⚠️

![jupytergis](https://github.com/geojupyter/jupytergis/blob/main/jupytergis.png)

## Features

- **Collaborative GIS Environment**: Work together on geographic data projects in real-time.
- **QGIS File Support**: Load, visualize, and manipulate QGIS project files (`.qgs`, `.qgz`), and other GIS data formats.
- **Interactive Maps**: Render interactive maps and geospatial visualizations within Jupyter notebooks using the JupyterGIS Python API.

## [🪄 Try JupyterGIS now! ✨](https://jupytergis.readthedocs.io/en/latest/lite/lab/index.html?path=france_hiking.jGIS)

This demo runs a JupyterLab instance entirely in your browser with WebAssembly! 🤯

Powered by [JupyterLite](https://jupyterlite.readthedocs.io/en/stable/?badge=latest).
Please note that [JupyterGIS' real-time collaboration features are not yet supported in JupyterLite](https://jupyterlite.readthedocs.io/en/latest/howto/configure/rtc.html).

## Installation

### Prerequisites

- JupyterLab (version 3.0 or higher)
- (OPTIONAL) QGIS installed on your system and its Python modules available in the PATH. e.g. `mamba install --channel conda-forge qgis`

### Installing JupyterGIS

#### From PyPI

```bash
python -m pip install jupytergis
```

#### From conda-forge

JupyterGIS is also packaged and distributed on [conda-forge](https://github.com/conda-forge/jupytergis-packages-feedstock).

To install and add JupyterGIS to a project with [`pixi`](https://pixi.sh/), from the project directory run

```
pixi add jupytergis
```

and to install into a particular conda environment with [`mamba`](https://mamba.readthedocs.io/), in the activated environment run

```
mamba install --channel conda-forge jupytergis
```

#### With Docker

```bash
docker run -p 8888:8888 ghcr.io/geojupyter/jupytergis:latest
```

Replace `latest` with a specific version number if you prefer.
Docker build source is at <https://github.com/geojupyter/jupytergis-docker>.

## Documentation

https://jupytergis.readthedocs.io

## Contributing

We welcome contributions from the community! To contribute:

- Fork the repository
- Make a dev install of JupyterGIS
- Create a new branch
- Make your changes
- Submit a pull request

For more details, check out our [CONTRIBUTING.md](https://github.com/geojupyter/jupytergis/blob/main/CONTRIBUTING.md).

## License

JupyterGIS is licensed under the BSD 3-Clause License. See [LICENSE](./LICENSE) for more information.
Loading