# Loop Project File Documentation {#mainpage}
<!-- TOC seems to break alignment (also note that if TOC is enabled you MUST use level 1 headers) -->
<!-- [TOC] -->
<!-- I would prefer to have an image linked to the loop project website but Doxygen markdown cannot do this -->
<!-- In Doxygen 1.8.16 (released 9/8/2019) it might be possible -->
[Loop Project Website](https://loop3d.org)
# What is Loop?
The Loop platform is an open source 3D probabilistic geological and geophysical modelling platform, initiated by Geoscience Australia and the OneGeology consortium. The project is funded by Australian territory, State and Federal Geological Surveys, the Australian Research Council and the MinEx Collaborative Research Centre.
# What is a Loop Project File?
A Loop Project File encapsulates all the data and models used or created in a Loop workflow. This includes the ability to create meta-data which provides provenance of the data and the methodology and history of how models are used and produced. The Loop Project File is based on netCDF and has APIs for C/C++ and Python (with the intention of creating a Fortran API in the future).
- [Loop Project File - C/C++](https://github.com/Loop3D/LoopProjectFile-cpp)
- [Loop Project File - Python](https://github.com/Loop3D/LoopProjectFile)
# Why use a project file?
There are several benefits to using a single project file. These include encapsulating the information in a single place, server storage and retrieval enabling batching of model creation over multiple servers, easily shared workflows, and storage efficiency among many more.
# Why use netCDF?
netCDF enables multi-dimensional data structure storage in a highly compressed format as well as data attribution for meta-data all within a single data file.
# Licencing
The Loop Project File python repository is under the MIT license
Raw data
{
"_id": null,
"home_page": null,
"name": "LoopProjectFile",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "earth sciences, data storage, structural geology, geology, loop3d",
"author": null,
"author_email": "Roy Thomson <roy.thomson@monash.edu>",
"download_url": "https://files.pythonhosted.org/packages/38/6c/d2ffa1ddf84a09d5314a0e0249eb7b8f5752df909428117a6dc56ddfb920/loopprojectfile-0.2.2.tar.gz",
"platform": null,
"description": "# Loop Project File Documentation {#mainpage}\n\n<!-- TOC seems to break alignment (also note that if TOC is enabled you MUST use level 1 headers) -->\n<!-- [TOC] -->\n\n<!-- I would prefer to have an image linked to the loop project website but Doxygen markdown cannot do this -->\n<!-- In Doxygen 1.8.16 (released 9/8/2019) it might be possible -->\n![Loop Project](loop_inv.png \"Loop Project\")\n[Loop Project Website](https://loop3d.org)\n\n# What is Loop?\nThe Loop platform is an open source 3D probabilistic geological and geophysical modelling platform, initiated by Geoscience Australia and the OneGeology consortium. The project is funded by Australian territory, State and Federal Geological Surveys, the Australian Research Council and the MinEx Collaborative Research Centre.\n\n# What is a Loop Project File?\nA Loop Project File encapsulates all the data and models used or created in a Loop workflow. This includes the ability to create meta-data which provides provenance of the data and the methodology and history of how models are used and produced. The Loop Project File is based on netCDF and has APIs for C/C++ and Python (with the intention of creating a Fortran API in the future).\n- [Loop Project File - C/C++](https://github.com/Loop3D/LoopProjectFile-cpp)\n- [Loop Project File - Python](https://github.com/Loop3D/LoopProjectFile)\n\n# Why use a project file?\nThere are several benefits to using a single project file. These include encapsulating the information in a single place, server storage and retrieval enabling batching of model creation over multiple servers, easily shared workflows, and storage efficiency among many more.\n\n# Why use netCDF?\nnetCDF enables multi-dimensional data structure storage in a highly compressed format as well as data attribution for meta-data all within a single data file.\n\n# Licencing\nThe Loop Project File python repository is under the MIT license\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Open source structural geology data storage for Loop Projects",
"version": "0.2.2",
"project_urls": {
"Bug Tracker": "https://github.com/loop3d/LoopProjectFile/issues",
"Documentation": "https://Loop3d.org/LoopProjectFile/",
"Source Code": "https://github.com/loop3d/LoopProjectFile"
},
"split_keywords": [
"earth sciences",
" data storage",
" structural geology",
" geology",
" loop3d"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "386cd2ffa1ddf84a09d5314a0e0249eb7b8f5752df909428117a6dc56ddfb920",
"md5": "17ad50cf75551c8145ee53e0d38b7dd1",
"sha256": "b5589228c7cecb0a39a9c8ec87dab803ba24aa8e001e85b04fd09cb916980ae5"
},
"downloads": -1,
"filename": "loopprojectfile-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "17ad50cf75551c8145ee53e0d38b7dd1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 29456,
"upload_time": "2024-12-16T04:38:45",
"upload_time_iso_8601": "2024-12-16T04:38:45.819046Z",
"url": "https://files.pythonhosted.org/packages/38/6c/d2ffa1ddf84a09d5314a0e0249eb7b8f5752df909428117a6dc56ddfb920/loopprojectfile-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-16 04:38:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "loop3d",
"github_project": "LoopProjectFile",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "netCDF4",
"specs": [
[
">=",
"1.5.4"
]
]
},
{
"name": "numpy",
"specs": []
},
{
"name": "pandas",
"specs": []
},
{
"name": "pytest",
"specs": []
},
{
"name": "conda-build",
"specs": []
},
{
"name": "anaconda-client",
"specs": []
}
],
"lcname": "loopprojectfile"
}
JSON
