Skip to content
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.

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

Document file format #129

Closed
prisae opened this issue Aug 25, 2020 · 2 comments
Closed

Document file format #129

prisae opened this issue Aug 25, 2020 · 2 comments
Labels
docs Stuff related to the documentation
Milestone

Comments

@prisae
Copy link
Member

prisae commented Aug 25, 2020

The functions

  • io.save, and
  • io.load

use a emg3d-specific file format (using h5, npz, or json). These functions are also used by

  • surveys.Survey.to_file; surveys.Survey.from_file;
  • simulations.Simulation.to_file; simulations.Simulation.from_file;
  • CLI interface.

However, the file format is not well documented.

@prisae prisae added the docs Stuff related to the documentation label Aug 25, 2020
@prisae prisae added this to the v1.0.0 milestone Aug 25, 2020
@prisae
Copy link
Member Author

prisae commented Aug 25, 2020

(Consider also geoh5py and the subsurface package.)

@prisae prisae pinned this issue Nov 7, 2020
@prisae prisae mentioned this issue Jan 16, 2021
12 tasks
@prisae prisae unpinned this issue Apr 16, 2021
@prisae
Copy link
Member Author

prisae commented May 28, 2021

Done in v1.

@prisae prisae closed this as completed May 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Stuff related to the documentation
Projects
None yet
Development

No branches or pull requests

1 participant