[WIP] add intro draft #76
Conversation
|
oops--i'd intented to replace that first #PySAL heading with something more descriptive |
|
is it possible to reorder the chapters so they follow the same outline described here (lib -> explore -> viz -> model) ? not that it's necessarily the perfect sequence, but it seems to me we should put lib first? |
There was a problem hiding this comment.
Such a great start!!! Thanks very much @knaaptime. I've left a couple of comments, more as suggestions than anything else.
|
|
||
| --- | ||
| The PySAL project began began life a decade ago as a collaboration between Serge Rey and |
There was a problem hiding this comment.
I'd start with a punch line of what PySAL is and seeks to accomplish. e.g. "PySAL is a comprehensive library implementing spatial analytics in Python.
|
|
||
| # PySAL | ||
|
|
||
| The original design of PySAL was to have a single monolithic library with subcomponents |
There was a problem hiding this comment.
Given the notebooks project will hopefully be visited by a lot of newcomers who want to do something with PySAL, it might be good to start upfront with how the library is structured and what its components are. If so, I'd suggest to move these two paragraphs to the bottom and re-title them as "The PySAL history" or something to that effect.
There was a problem hiding this comment.
cool. I'd wondered about this as i was writing... this history is an important part of the story of why we're doing this book, but also dont want to scare folks away with too much background before getting to the fun stuff
|
|
||
| ## Core Data Structures | ||
|
|
||
| `libpysal` is the core package and it is here where we handle file-io, spatial weights, and |
There was a problem hiding this comment.
Should we add links to each library's notebooks (or package pages) when we mention?
|
As for the re-ordering of the chapters, it's definitely posible though it'd take a bit of refactoring of the code. We currently simply pull the folders in the order they appear when downloaded: https://github.com/pysal/notebooks/blob/master/lib/build.py#L150 I'm not sure what the most straightforward way would be to re-arrange as desired in an automated way. PRs most welcome :-) |
Would it be possible to change the ordering by editing https://github.com/pysal/notebooks/blob/master/docs/_data/toc.yml ? |
|
Yes, you could change it there but everything in |
here's a start on the intro. my intent was to describe a bit of the motivation for the book project and use serge's paper to give a bit of background on the current structure. let me know if you'd like to take it in another direction (or if there are details I borked) and i can keep plugging away