Skip to main content

A Python framework for forest estate modeling and wood supply simulation

Project description

tests Documentation Status

ws3 - Wood Supply Simulation System

ws3 (Wood Supply Simulation System) is a Python package for modeling landscape-level wood supply planning problems.

Read the tutorial here.

Table of Contents


Installation

We recommend installing ws3 package into a Python venv (virtual environment) to minimize interactions with system-level packages.

In 000_venv_python_kernel_setup.ipynb we provide the instructions for how to set up a new venv-sandboxed Python kernel and make it available in your JupyterLab environment, assuming that you are running this notebook in a standard linux-based environment and a regular (non-root) using running commands in a bash terminal.

Modules

ws3 consists of the following main modules:

  • common.py: Contains definitions for global attributes, functions, and classes that might be used anywhere in the package.
  • core.py: Contains Interpolator class used by Curve class to interpolate between real data points.
  • forest.py: Implements functions for building and running wood supply simulation models.
  • opt.py: Implements functions for formulating and solving optimization problems.
  • spatial.py: Implements the ForestRaster class, which can be used to allocate an aspatial disturbance schedule (for example, an optimal solution to a wood supply problem generated by an instance of the forest.ForestModel class) to a rasterized representation of the forest inventory.

Usage

Multiple examples are available to demonstrate the utilization of ws3. Below is an overview explaining each of these examples:

License

MIT License Copyright (c) 2025 Gregory Paradis.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

  • The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  • The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the software or the use or other dealings in the software.

Authors and Contributors

Primary Author:
Gregory Paradis — Lead developer and architect of the ws3 framework.

Additional Contributors:
Elaheh Ghasemi
Kathleen Coupland
Salar Ghotb

For full contribution history, see GitHub Contributors.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ws3-1.0.1.tar.gz (60.6 kB view details)

Uploaded Source

Built Distribution

ws3-1.0.1-py3-none-any.whl (64.0 kB view details)

Uploaded Python 3

File details

Details for the file ws3-1.0.1.tar.gz.

File metadata

  • Download URL: ws3-1.0.1.tar.gz
  • Upload date:
  • Size: 60.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for ws3-1.0.1.tar.gz
Algorithm Hash digest
SHA256 b7f005d8a8d6d443404e00ceb9a309da52e8a9c1735add78a552b7930abc28e6
MD5 9ec1c7a3707edf3048f8a1def073dd40
BLAKE2b-256 2f4e2fabd4a1d16410dcf92969020737682d7e25a18394da0cbeb283bd0a3d00

See more details on using hashes here.

File details

Details for the file ws3-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: ws3-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 64.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for ws3-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f62d65b8ea6d59285a3c73aaa9def85f37ac928eb11630419b904d5dadf95dc5
MD5 0d0560df0dfb2788d79c8c0c72575874
BLAKE2b-256 a3f9dd542b1549c6e9814d76ea1729b5545f10cf311b9879580527fa6122932c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page