Added pyincore-data NSI example notebook

[ywkim312]

To test this, please install pyincore-data's develop branch to your test environment (e.g., your local machine) first.

[navarroc]

I would suggest putting this example notebook in our tutorials page: https://tools.in-core.org/doc/incore/tutorials.html. Also, we might want to expand this notebook a little to show using the parser to fetch the data for one county and write it to a shapefile or geopackage. Also, we should put some headers so the notebook looks nicer like our other tutorials. You could even add a step to show posting the inventory to the IN-CORE service, but I would choose something small (e.g. seaside or similar).

[navarroc]

@ywkim312 Can you link to this new tutorial somewhere from the documentation? I would put it in the Tutorials section (tutorials.md) or at least the Examples section (notebook_other.md). Tutorials would likely get more visibility and this is a good tutorial to get started with NSI data.

[navarroc]

Just some comments for next week - I think we can remove the nsi_test.gpkg file, right? We don't need that in the repository. Also, we need to run the NSI notebook and save the output cells so it gets rendered in the docs.

[ywkim312]

I would suggest putting this example notebook in our tutorials page: https://tools.in-core.org/doc/incore/tutorials.html. Also, we might want to expand this notebook a little to show using the parser to fetch the data for one county and write it to a shapefile or geopackage. Also, we should put some headers so the notebook looks nicer like our other tutorials. You could even add a step to show posting the inventory to the IN-CORE service, but I would choose something small (e.g. seaside or similar).

Everything has been added except the posting the inventory to service. Maybe, we can add this later after the incore-service for this is up and running

[ywkim312]

Just some comments for next week - I think we can remove the nsi_test.gpkg file, right? We don't need that in the repository. Also, we need to run the NSI notebook and save the output cells so it gets rendered in the docs.

no, we need the file to show the direct conversion of geopackage to nsi inventory. If we remove the gpkg file, we need to remove the cell that does this in the notebook.

[navarroc]

Just some comments for next week - I think we can remove the nsi_test.gpkg file, right? We don't need that in the repository. Also, we need to run the NSI notebook and save the output cells so it gets rendered in the docs.

no, we need the file to show the direct conversion of geopackage to nsi inventory. If we remove the gpkg file, we need to remove the cell that does this in the notebook.

We should follow the same pattern we do with the other tutorials. We create a zip of all the files needed to run the tutorial and that goes in the "notebooks" folder (see create_local_hazard.zip) and then in the tutorials section, we put just the notebook where we've ran it so the output is displayed in the documentation. The notebook in the zip should have cleared output.

[navarroc]

I would suggest putting this example notebook in our tutorials page: https://tools.in-core.org/doc/incore/tutorials.html. Also, we might want to expand this notebook a little to show using the parser to fetch the data for one county and write it to a shapefile or geopackage. Also, we should put some headers so the notebook looks nicer like our other tutorials. You could even add a step to show posting the inventory to the IN-CORE service, but I would choose something small (e.g. seaside or similar).

Everything has been added except the posting the inventory to service. Maybe, we can add this later after the incore-service for this is up and running

I don't understand. The output of the notebook is a local building dataset (shapefiles). You can add another cell to show uploading it to the service as a building dataset. I didn't meant using the new NSI endpoint.

[ywkim312]

@ywkim312 Can you link to this new tutorial somewhere from the documentation? I would put it in the Tutorials section (tutorials.md) or at least the Examples section (notebook_other.md). Tutorials would likely get more visibility and this is a good tutorial to get started with NSI data.

Added this to tutorial along with the zip file

[navarroc]

Just some comments for next week - I think we can remove the nsi_test.gpkg file, right? We don't need that in the repository. Also, we need to run the NSI notebook and save the output cells so it gets rendered in the docs.

no, we need the file to show the direct conversion of geopackage to nsi inventory. If we remove the gpkg file, we need to remove the cell that does this in the notebook.

We should follow the same pattern we do with the other tutorials. We create a zip of all the files needed to run the tutorial and that goes in the "notebooks" folder (see create_local_hazard.zip) and then in the tutorials section, we put just the notebook where we've ran it so the output is displayed in the documentation. The notebook in the zip should have cleared output.

Nevermind, I was wrong. We have been including the data too with the tutorials.

[navarroc]

Can you clear the output from the jupyter notebook in the zip file?

[ywkim312]

Can you clear the output from the jupyter notebook in the zip file?

Oh, so this one shouldn't have results? I removed them and pushed.