Install#

As an application#

Install openplaces as an application with its own environment.

This is the recommended setup for developers and collaborators.

Open your Terminal.

Windows

Open Command Prompt or Anaconda Prompt

macOS

Open Terminal

Linux

Open Terminal
Change to the directory where you want to keep the openplaces codebase:
```
# Example: 'code' folder in the user directory
cd ~/code
```

Clone the openplaces Github repository:

git clone https://github.com/chrnolte/openplaces.git

You need to have a version of the Anaconda package manager installed.

Either conda or mamba need to be executable from your Terminal:

Windows

Open Anaconda Prompt

macOS

Open Terminal

Linux

Open Terminal

If you don’t have conda yet, we recommend installing Miniconda, a free, miniature installation of Anaconda.

mamba is a fast environment solver for conda. It will speed up your installation considerably.

If you don’t have it installed, run conda install mamba -y before running the setup script.

When you have mamba ready, run the setup script:

python dev.py setup

The setup script will let you choose the name of your environment.

It will also ask you whether:

You want to install 7z.

The 7z utility allows you to unpack uncommon formats of compressed .zip files, such as Windows formats used to access public parcels in the state of Virginia, US (US-VA).
You want the QGIS tool installed in the Processing Toolbox.

This tool allows you to import openplaces’ .parquet tables with associated geometry parquet files as a single, joined vector layer.
You want to install a shortcut in your user folder.

This lets you type openplaces into your Terminal to:
- activate your environment
- start Jupyter in your notebooks folder
- and open a browser so you can start coding

Once the environment is installed, you need to configure your installation.

To remove your environment, use:

python dev.py clean