The Python interface to SyncroSim
pysyncrosim
can be installed using either the conda
or pip
package managers. conda
is a general package manager capable of installing packages from many sources, but pip
is strictly a Python package manager. While the installation instructions below are based on a Windows 10 operating system, similar steps can be used to install pysyncrosim
for Linux.
Before beginning the installation of pysyncrosim
, make sure you have the latest release of SyncroSim installed.
pysyncrosim
was tested and developed using Python 3.12 and SyncroSim 2.4.44. Because pysyncrosim
uses rasterio
for integrating spatial data, it also requires a C library dependency: GDAL >=2.3.
python=3.12
pandas=2.1.3
numpy=1.26.0
rasterio=1.3.9
Follow these steps to get started with conda
and use conda
to install pysyncrosim
.
-
Install
conda
using the Miniconda or Anaconda installer (in this tutorial we use Miniconda). To install Miniconda, follow this link and under the Latest Miniconda Installer Links, download Miniconda for your operating system. Open the Miniconda installer and follow the default steps to installconda
. For more information, see the conda documentation. -
To use
conda
, open the command prompt that was installed with the Miniconda installer. To find this prompt, type "anaconda prompt" in the Windows Search Bar. You should see an option appear called Anaconda Prompt (miniconda3). Select this option to open a command line window. All code in the next steps will be typed in this window. -
You can either install
pysyncrosim
and its dependencies into your base environment, or set up a newconda
environment (recommended). Run the code below to set up and activate a newconda
environment called "myenv" that uses Python 3.12.
# Create new conda environment
conda create -n myenv python=3.12
# Activate environment
conda activate myenv
You should now see that "(base)" has been replaced with "(myenv)" at the beginning of each prompt.
- Set the package channel for
conda
. To be able to install the dependencies forpysyncrosim
, you need to access theconda-forge
package channel. To configure this channel, run the following code in the Anaconda Prompt.
# Set conda-forge package channel
conda config --add channels conda-forge
- Install
pysyncrosim
usingconda install
. Installingpysyncrosim
will also install its dependencies:pandas
,numpy
, andrasterio
.
# Install pysyncrosim
conda install pysyncrosim
pysyncrosim
should now be installed and ready to use!
Use pip
to install pysyncrosim
to your default python installation. You can install Python from https://www.python.org/downloads/. You can also find information on how to install pip
from the pip documentation.
Install pysyncrosim
using pip install
. Installing pysyncrosim
will also install its dependencies: pandas
, numpy
, and rasterio
.
# Make sure you are using the latest version of pip
pip install --upgrade pip
# Install pysyncrosim
pip install pysyncrosim
For a basic usage example with the helloworldSpatialPy package, see the spatial_demo.py and input-raster.tif in the examples folder. To download the spatial_demo.py file, view the file on GitHub and select Raw. From the raw view, right-click and select Save As.... To run the spatial demo, you will also need to install the matplotlib
Python package. You can install this package using the following code.
# Install matplotlib
conda install matplotlib
If you wish to design SyncroSim packages using python and pysyncrosim
, you can follow the Creating a Package and Enhancing a Package tutorials on the SyncroSim documentation website. Note that SyncroSim v2.3.10 is required to develop python-based SyncroSim packages.