Skip to content

Commit

Permalink
Merge pull request #130 from ryanmswan/dev
Browse files Browse the repository at this point in the history
Updated onboarding doc
  • Loading branch information
ryanmswan authored Dec 15, 2019
2 parents 38bbcfa + a9dd13a commit d0198d9
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions dataAnalysis/onboarding/311-onboarding.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@
"\n",
"### General Operations\n",
"\n",
"311-data makes use of a number of tools, but from a global level the vast majority of the code base exists in `Python 3`. In Python the most important data analysis packages in use are.\n",
"311-data makes use of a number of tools, but from a global level the vast majority of the code base exists in `Python 3`.\n",
"\n",
"[pandas](https://pandas.pydata.org/) is the workhorse of the data analysis workflow is `pandas`. The majority of data cleaning, filtering, and reorganization are performed using this library. It also handles ingestion of data into Postgres. [numpy](https://numpy.org/) forms the underpinning of `pandas` and is also heavily utilized.\n",
"[pandas](https://pandas.pydata.org/) is the workhorse of the data analysis. The majority of data cleaning, filtering, and reorganization are performed using this library. It also handles ingestion of data into Postgres. [numpy](https://numpy.org/) forms the underpinning of `pandas` and is also heavily utilized.\n",
" \n",
"### Data Source\n",
"\n",
Expand Down Expand Up @@ -85,6 +85,8 @@
"\n",
"### Install Dependencies\n",
"\n",
"An install script [has been provided in the github repo.](https://github.com/hackforla/311-data/blob/e10b829bd669b549c63a6a4fac3efe6f0c937979/onboard.sh) Run the script and make sure you can pass the associated checks.\n",
"\n",
"Take a look at the [requirements file](https://github.com/hackforla/311-data/blob/dev/server/requirements.txt) and see if you have everything you need to get going. The most important tools are:\n",
"\n",
" - Python 3\n",
Expand Down Expand Up @@ -112,7 +114,7 @@
"\n",
"Most important files are included in the server subdirectory. \n",
"\n",
"Run `docker compose-up` using the [yml file](https://github.com/hackforla/311-data/blob/dev/server/Dockerfile) included in the repo. **CAUTION: THIS FILE MAY NEED TO BE UPDATED.**\n",
"Run `docker compose-up` using the [yml file](https://github.com/hackforla/311-data/blob/master/Orchestration/docker-compose-default.yml) included in the repo. Reference the [README.md file in the Orchestration folder](https://github.com/hackforla/311-data/blob/master/Orchestration/README.md) for information on how to initialize the docker instance.\n",
"\n",
"Create your personal copy of `settings.cfg` from [settings.example.cfg](https://github.com/hackforla/311-data/blob/dev/server/src/settings.example.cfg). You will need to specify your local password for your dockerized `postgres` instance. `settings.cfg` is included in `.gitignore` so changes to this file will not be committed to the repo, allowing you to save your personal login credentials here.\n",
"\n",
Expand Down

0 comments on commit d0198d9

Please sign in to comment.