New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation: expand description Api Reference text for imod.formats.ipf.save #1182

Open

FransRoelofsen opened this issue Aug 30, 2024 · 1 comment

Labels

FransRoelofsen commented Aug 30, 2024

The IPF file is written based on information in the pandas.DataFrame. Therefore some dataframe columns are required.

Text suggestion:

df (pandas.DataFrame) – DataFrame containing the data to write. Columns required for X ("x") and Y ("y") coordinates.

in case of itype = 1

1 or "timeseries". Columns requires with temporal information ("time")

in case of itype = 2.

2 or "borehole1d". Columns required for vertical reference ("top")

in case of itype = 3.

3 or "cpt". Columns required for vertical reference ("top")

in case of itype = 4.

4 or "borehole3d". Columns required "x_offset", "y_offset", "top"

And what about similar column requirements for imod.formats.ipf.write?

github-project-automation bot added this to iMOD Suite

github-project-automation bot moved this to 📯 New in iMOD Suite

Author

FransRoelofsen commented Aug 30, 2024

in addition:
"top" is defined as the individual top of each Interface described in a single borelog. E.g.

3
2,2
top,1e+20
lithology,1e+20
-1.9,"C"
-2.3,"P"
-4.0,"C"

JoerivanEngelen added the documentation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment