FAIRMD Lipids v1.3.2a0

Python Interface

  • Getting started
  • fairmd-lipids CLI
  • Project structure
    • fairmd.lipids
    • developer
    • Project testing

Membrane Databank

  • Data Organization
  • Data Contribution
FAIRMD Lipids v1.3.2a0
  • Project structure
  • View page source

Project structure

Project has four sub-folders in the root directory:

  1. src/fairmd/lipids

    Main project package. Contains most of the project’s logic and API.

    More info on fairmd-lipids

  2. tests

    Pytest-based unit and regression tests.

    More info on tests.

  3. docs

    Documentation source files.

  4. developer

    Helper scripts and utilities for developers and CI/CD pipelines. It is not distributed with the package.

  • fairmd.lipids
    • Subfolders
      • fairmd.lipids.SchemaValidation
      • fairmd.lipids.bin
      • fairmd.lipids.settings
    • Python files
      • fairmd.lipids.analyze module
      • fairmd.lipids.analyze_nmrpca module
      • fairmd.lipids.core module
      • fairmd.lipids.databankLibrary module
      • fairmd.lipids.databankio module
      • fairmd.lipids.databankop module
      • fairmd.lipids.jpyroutines module
      • fairmd.lipids.jsonEncoders module
      • fairmd.lipids.maicos module
      • fairmd.lipids.openmm_parser module
      • fairmd.lipids.plottings module
      • fairmd.lipids.quality module
      • fairmd.lipids.utils module
    • Module contents
      • FMDL_DATA_PATH
      • FMDL_EXP_PATH
      • FMDL_MOL_PATH
      • FMDL_SIMU_PATH
      • RCODE_COMPUTED
      • RCODE_ERROR
      • RCODE_SKIPPED
  • developer
    • Python files
      • developer.ProcessInfoFile module
      • developer.RunAnalysis module
      • developer.ValidateData module
      • developer.align-mapping module
      • developer.buildH_calcOP_test module
      • developer.check_bonds module
      • developer.check_densities module
      • developer.check_mappings module
  • Project testing
    • Testing strategy
    • Simulation.1 and Simulation.2
Previous Next

© Copyright 2025, NMRlipids Open Collaboration <databank@nmrlipids.fi> OSI Approved: GNU General Public License v3 (GPLv3) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version .

Link to GNU GPL v3 License

Link to the GitHub repository

Built with Sphinx using a theme provided by Read the Docs.