pyWellSFM Python Package
pyWellSFM project contains:
docs: documentation source
notebooks: Jupyter notebooks that show how to use pyWellSFM features
tests: unit and integrated tests. Tests files contain numerous examples on how to use pyWellSFM.
src: pyWellSFM source code
Main API
The main API can be imported directly from pywellsfm package:
from pywellsfm import (
AccumulationCurve,
AccumulationModel,
AccumulationModelElementOptimum,
AccumulationModelElementGaussian,
Curve,
DepthAgeModel,
Element,
EnvironmentalFacies,
Facies,
FaciesCriteria,
FaciesCriteriaCollection,
FaciesCriteriaType,
FaciesModel,
FSSimulator,
Marker,
PetrophysicalFacies,
RealizationData,
Scenario,
SedimentaryFacies,
UncertaintyCurve,
Well,
)
# do anything with the imported classes and functions
Core model
pywellsfm.AccumulationModelpywellsfm.AccumulationModelElementOptimumpywellsfm.AccumulationModelElementGaussianpywellsfm.AccumulationModelElementCombinationpywellsfm.Curvepywellsfm.AccumulationCurvepywellsfm.UncertaintyCurvepywellsfm.DepositionalEnvironmentpywellsfm.DepositionalEnvironmentModelpywellsfm.Elementpywellsfm.model.EnvironmentConditionModelStatspywellsfm.model.EnvironmentConditionModelUniformpywellsfm.model.EnvironmentConditionModelTriangularpywellsfm.model.EnvironmentConditionModelGaussianpywellsfm.model.EnvironmentConditionModelConstantpywellsfm.model.EnvironmentConditionModelCurvepywellsfm.model.EnvironmentConditionModelCombinationpywellsfm.model.EnvironmentConditionsModelpywellsfm.Faciespywellsfm.FaciesCriteriapywellsfm.FaciesCriteriaCollectionpywellsfm.FaciesCriteriaTypepywellsfm.FaciesModelpywellsfm.Markerpywellsfm.Scenariopywellsfm.RealizationDatapywellsfm.Well
Method & Types
Marker type:
pywellsfm.StratigraphicSurfaceType
IO
Loader:
Accumulation model:
loadAccumulationModel()Curve:
loadCurvesFromFile()Depositional Environment Model:
loadDepositionalEnvironmentModel()Environment Conditions Model:
loadEnvironmentConditionsModel()Facies Model:
loadFaciesModel()Well:
loadWell()Simulation:
loadFSSimulation()Scenario:
loadScenario()Realization Data:
loadRealizationData()