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 CLI functionality #197

Open
leotrs opened this issue May 21, 2019 · 6 comments
Open

Add CLI functionality #197

leotrs opened this issue May 21, 2019 · 6 comments
Labels
enhancement New feature or request

Comments

@leotrs
Copy link
Collaborator

leotrs commented May 21, 2019

Examples of desired usage:

$ netrd --dist NBD edgelist1.txt edgelist2.txt
$ netrd --recons ConvergentCrossMapping timeseries.csv
$ netrd --simulate SIR edgelist.txt
@leotrs leotrs added the enhancement New feature or request label May 21, 2019
@leotrs
Copy link
Collaborator Author

leotrs commented May 21, 2019

Adding CLI functionality to the package is very very easy and will not require a different package (as suggested on #186). It pretty much just requires one more module and some boilerplate in setup.py.

@sdmccabe
Copy link
Collaborator

How do parameters work, given that each method has different ones? Still --param?

@leotrs
Copy link
Collaborator Author

leotrs commented May 23, 2019

Good question. It won't be hard to make the CLI commands accept a variable number of parameters using argparse. The problem I think will be with the naming of all the parameters. We don't want something like this

$ netrd --dist NonBacktrackingSpectral file1.txt file2.txt --num_eigs 10
$ netrd --dist LaplacianSpectral file1.txt file2.txt --eigenvalues 10

when both num_eigs and eigenvalues are doing the exact same thing. So jointly with this we would have to implement a fairly major review and standardization of parameters.

@sdmccabe
Copy link
Collaborator

I guess that can be our post-NetSci breaking change.

@sdmccabe
Copy link
Collaborator

Flagging that this almost certainly can't be developed at the same time as #174.

@leotrs
Copy link
Collaborator Author

leotrs commented Jun 12, 2019 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants