FEATURE: Cleaner Entry Points

Marchowes / pyProm

Surface Network Analyzer.

BSD 3-Clause "New" or "Revised" License

6 stars 2 forks source link

FEATURE: Cleaner Entry Points #13

Closed Marchowes closed 7 years ago

Marchowes commented 8 years ago

Right now, libs are sort of scattershot, which isn't a big deal since development is underway. what will ultimately need to be done is a "clean" pyProm type file/object will need to be cobbled together as an entry point for someone trying to do regular surface network analysis.

Marchowes commented 8 years ago

I could have just said "write an API"

Marchowes commented 7 years ago

I suspect the best approach is to create a class called "Domain".

Domain accepts the following:

Datamap()

Has the following Functions:

run(): calls Creates Analyze Object and runs, Creates walk object and runs.
read(): Loads json/yaml file
write(): Writes json/yaml file
@saddles(): saddles.points
@summits(): summits.points
@linkers(): linkers

contains saddle, summit, and linker objects.

Future Features: -Combine Domains

Marchowes commented 7 years ago

https://github.com/Marchowes/pyProm/pull/60