Skip to content

README.md

Latest commit

 

History

History
30 lines (22 loc) · 1.08 KB

README.md

File metadata and controls

30 lines (22 loc) · 1.08 KB
Raw

The python version of the Survey Simulator

The python implementation builds an ossssimlib extension from the F95 sources (via f90wrap) and wraps it with Python classes in ossssim (OSSSSim, model helpers, etc.).

See pydoc ossssim and the top-level examples/ directory.

Survey characterization formats and a mini example are documented in ../docs/. Full survey characterizations and model files are distributed separately as SurveySimulator-Data (DOI / web download; not shipped inside this Python package). In-repo test fixtures live under ../F95/tests/Surveys/ and ../F95/tests/Models/.

Installation

pip install .

(from the repository root). Requires gfortran, make, and f90wrap. The build runs make -C F95 MODULE=ossssimlib and installs _ossssimlib plus the ossssimlib Python package alongside ossssim.

Contents

  • ossssim — Python API
  • ossssimlib / _ossssimlib — f90wrap Fortran extension (built at install)
  • ../tests — unit tests
  • ../examples — usage examples