User Guide

To get started with mapflpy, please refer to the following sections:

• Installation
  • Required Dependencies
  • Optional Dependencies
• Overview
  • Tracer vs. TracerMP
  • Tracer as Dictionary
  • Tracing Fieldines
  • Using Scripts
  • Utilities
• Development
  • Overview of the Workflow
  • Setting Up the Development Environment
    • 1. Clone the repository
    • 2. Create the virtual environment(s)
    • 3. Build the local Fortran shared object
  • Running Tests Locally
  • Building the Documentation Locally
  • Reproducing CI Locally with Nox
  • Reference: the tools/ Scripts
    • make_build.py
    • make_docs.py
    • make_intersphinx.py
  • Continuous Integration / Delivery