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

updated to latest jutul and jutul darcy version, revise pyplot to pyt… #35

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

Conversation

shiqinzeng
Copy link

update to latest jutul and jutul darcy version, change pyplot to pythonplot

@@ -1,31 +0,0 @@
name = "JutulDarcyRules"
Copy link
Member

Choose a reason for hiding this comment

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

Cannot delete this file it's mandatory for any Julia package

@@ -1,11 +1,11 @@
## A simple 2D example for fluid-flow simulation

using DrWatson
@quickactivate "JutulDarcyRules-example"
@quickactivate "JutulDarcyRules"
Copy link
Member

Choose a reason for hiding this comment

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

Any reason all these example use DrWatson/quickactivate instead of only using JutulDarcyRules as a package?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd guess because this lets a user run the files without doing any setup (assuming they have DrWatson installed). So they can run the examples without having to install JutulDarcyRules.

Do you think we should get rid of it? It isn't a standard way to give package examples, and it may be annoying for people who don't want to install DrWatson. But it does benefit people who rely on DrWatson, and those people probably need more support than the kind of advanced users who don't want to install DrWatson.

Copy link
Member

Choose a reason for hiding this comment

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

I mean both sides have their advantages. DrWatson makes things very stable in terms of reproducibility, and it also makes it a constraint on the user as for examples, the Project.toml contains a lot of dependencies that are not actually needed for the project but only for the examples.

Fundamentally, IMO, this package is a tool, not an application, so it should be as minimal as possible to be included in people's workflow easily. That means trimming the dependencies to a minimum and, if needed, make a separate repo with a bunch of examples and applications using DrWatson. But i don't think the package itself should be using DrWatson.

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