search

gmggroup / omf-python

Python library for working with OMF files
MIT License
79 stars 20 forks source link

Improve documentation and add more examples #39

Open fwkoch opened 5 years ago

fwkoch commented 5 years ago

The documentation needs to be more friendly for new users. Most importantly, we need multiple, real examples.

banesullivan commented 5 years ago

Most importantly, we need multiple, real examples.

I'm working on a project now that will be complete in April using a pretty sweet (real and large scale) dataset that has a creative commons license on it. I'd be happy to share the Jupyter notebooks I've made (come April) that load in a bunch of different data files from CSV formats, Shapefiles, and the likes to create useable data structures in one big OMF project file and host the project file on a Google Drive folder somewhere that folks could download

fwkoch commented 5 years ago

@banesullivan - that would be very cool. A combo of notebooks on github, example code in readthedocs, and a reference .omf file for download would be amazing. Sounds like timing will likely coincide with OMF v2 development as well.

banesullivan commented 5 years ago

This may be of interest: http://forge.pvgeo.org/project/

This is still in a proof-of-concept stage... but it shows the process of aggregating various data files/formats into a few OMF project files. Then there are some visualization notebooks that inspect the data in the OMF project files.