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

Contribution with a 1D magnetotelluric example #100

Merged
merged 19 commits into from Mar 6, 2023
Merged

Conversation

hseille
Copy link
Contributor

@hseille hseille commented Feb 1, 2023

I have added a 1D magnetotelluric problem. I tried to follow the template as much as possible.
I built it with cofi-espresso, it worked.
I also prepared some examples to run within jupyter notebooks, they are not included here, I will include them to the cofi-examples later I guess?

Cheers,
Hoel

@valentineap
Copy link
Member

Thanks for this, @hseille - congratulations on being our first external contributor!

I think you've already discussed this with @jwhhh so I'll let her deal with the pull request.

We haven't yet fully decided how we manage and serve things like Jupyter notebooks. We probably want to automagically link these into the documentation, but @jwhhh and I need to think about how we do this in a standardised way. It would be very useful to have access to your notebooks so that we can experiment with different solutions -- perhaps you could create a folder contrib/magnetotelluric_1d/examples or similar and add them there for now. We can move them later if needed.

Thanks again for spending your time on this - and if you have any comments/suggestions about the contribution process/instructions/etc we'd love to hear them!

Copy link
Member

@jwhhh jwhhh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for being our first external contributor! The example looks all good and passes all tests. It would be great if you could add some text to introduce what the problem is about (as is also mentioned in a separate comment under README.md).

And if you have notebooks to include, that's great! Please include your notebook(s) under a "contrib/magnetotelluric/examples" folder, and we'll try to update our infrastructure so that your example notebook will be displayed in the documentation.

Thanks again for the contribution!

@@ -0,0 +1,142 @@
# Magnetotelluric 1D

<!-- Please write anything you'd like to explain about the forward problem here -->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello Hoel, would you like to document briefly what the problem is about, how to use it (if there's anything special and additional to the "standard" interface), and anything else you think would be beneficial to explain? This document is in Markdown format, so you can write titles starting with # (## for header 2 and so on) and normal paragraphs with empty lines in between, etc. And please remove all the currently existing content after that.

@jwhhh jwhhh merged commit 14107f3 into inlab-geo:main Mar 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants