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

Add quick start example with plot #371

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

hallgrim
Copy link

@hallgrim hallgrim commented May 5, 2019

The quick start section should show a few common usecases, and be clear in terms of usage patterns.

The quick start section should show a few common usecases, and be clear in terms of usage patterns.
@mrava87
Copy link

mrava87 commented May 6, 2019

Hi,
nice idea :)

Since you also add plots then I would say that this is more appropriate for the companion repo https://github.com/equinor/segyio-notebooks (we should have a link to it in the README?). In that repo you can make a notebook running those steps and provide the data or a set of commands for downloading the data so that everyone can reproduce your example...

@mrava87
Copy link

mrava87 commented May 6, 2019

PS: actually realized we already have a link to that repo in README, example notebooks in this sentence is linked to that repo When segyio is built and installed, you're ready to start programming! Check out the tutorial, examples, example programs, and example notebooks

@hallgrim
Copy link
Author

hallgrim commented May 9, 2019

The idea of the simple plot was to quickly show off the capabilities of the library, and create a visual version of what it can achieve. I do agree that examples belongs in the notebook companion, in particular examples that pulls in other dependencies.

We were trying to make the once exception that emphasis what kind of things you can see in the notebooks and that would make sure that it was easy to realise what this library can do.

Copy link

@jokva jokva left a comment

Choose a reason for hiding this comment

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

Needs the addition and rendering of the actual plot.

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.

3 participants