pysyncrosim

The Python interface to SyncroSim

Installation

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.

Dependencies

pysyncrosim v2.0 was tested and developed using Python 3.12 and SyncroSim 3.0.9. Because pysyncrosim uses rasterio for integrating spatial data, it also requires a C library dependency: GDAL >=3.7.

python=3.12

pandas=2.2.2

numpy=2.1.0

rasterio=1.3.10

Using `conda`

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 install conda. 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 new conda environment (recommended). Run the code below to set up and activate a new conda 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 for pysyncrosim, you need to access the conda-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 using conda install. Installing pysyncrosim will also install its dependencies: pandas, numpy, and rasterio.

# Install pysyncrosim
conda install pysyncrosim

pysyncrosim should now be installed and ready to use!

Using `pip`

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

Usage

Getting Started

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

SyncroSim Package Development

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.

Metadata

Release files for pysyncrosim 2.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pysyncrosim 2.2.0
File	Size	Uploaded	Provenance
pysyncrosim-2.2.0.tar.gz	42.5 kB	Mar 26, 2026	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for pysyncrosim 2.2.0
File	Interpreter	ABI	Platform	Reset
pysyncrosim-2.2.0-py3-none-any.whl 41.3 kB Mar 26, 2026 Without provenance	Python 3	none	any	Details

Total release size: 83.7 kB

Release files / pysyncrosim-2.2.0.tar.gz

Download URL	pysyncrosim-2.2.0.tar.gz
Size	42.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`75095d12c666c160a196a68d206b29f6f5b968d7680e488f421955fe944efab9`
BLAKE2b-256 checksum How to use checksums	`43c2a2410cef230f4582dd9f3bf7684e6fef14e2dd747c3ee3feac0b2d7f48a2`
Upload date	Mar 26, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.14.3`

Release files / pysyncrosim-2.2.0-py3-none-any.whl

Download URL	pysyncrosim-2.2.0-py3-none-any.whl
Size	41.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`ce123686876ea66a698e5ea58980c4839ccaf5ab3c9480afa90715fc10796ad3`
BLAKE2b-256 checksum How to use checksums	`d88f71e62ae4384db0540da88628a62c7cdb79ba8de6034273c92a1b2573d019`
Upload date	Mar 26, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.14.3`

Security for pysyncrosim 2.2.0

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.