Skip to content

Add CLI functionality #197

Open
Open
Add CLI functionality#197
Labels
enhancementNew feature or request

Description

@leotrs
leotrs
opened on May 21, 2019

Examples of desired usage:

$ netrd --dist NBD edgelist1.txt edgelist2.txt
$ netrd --recons ConvergentCrossMapping timeseries.csv
$ netrd --simulate SIR edgelist.txt

Activity

  1. leotrs
    added
    enhancementNew feature or request
    on May 21, 2019

  2. leotrs commented on May 21, 2019

    @leotrs
    leotrs
    on May 21, 2019
    CollaboratorAuthor

    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.

  3. sdmccabe commented on May 22, 2019

    @sdmccabe
    sdmccabe
    on May 22, 2019
    Collaborator

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

  4. leotrs commented on May 23, 2019

    @leotrs
    leotrs
    on May 23, 2019
    CollaboratorAuthor

    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.

  5. sdmccabe commented on May 23, 2019

    @sdmccabe
    sdmccabe
    on May 23, 2019
    Collaborator

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

  6. sdmccabe commented on Jun 12, 2019

    @sdmccabe
    sdmccabe
    on Jun 12, 2019
    Collaborator

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

  7. leotrs commented on Jun 12, 2019

    @leotrs
    leotrs
    on Jun 12, 2019 via email
    CollaboratorAuthor
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions