From caabd2c2a06c9f882d80f637011f26835b792099 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rapha=C3=ABl=20Nussbaumer?= Date: Fri, 31 Dec 2021 19:20:24 -0500 Subject: [PATCH] Update README.md --- README.md | 35 +++++++++-------------------------- 1 file changed, 9 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 0f7a222..9449832 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,14 @@ # eBirdToLaTex Checklist Generator # -eBirdToLaTex Checklist Generator is a Python module which generates a customisable bird checklist based on a specific dataset downloaded from [eBird](http://ebird.org/). The web version of the generator is currently not available. +eBirdToLaTex Checklist Generator is a Python module which generates a customisable bird checklist based on a specific dataset downloaded from [eBird](http://ebird.org/). The web version of the generator is not available anymore as eBird is requiring to login to get barchart data. -## How to use the python version ? ## -If you have python3 (python2 won't work with ```urllib```) and LaTeX, take the ```e2L.py``` module with the ```script_e2L.py``` and ```Template_default```. Internet connection is required to download updated bird taxonomy list, language traduction as well as location barchart data. - -### Load eBird barchart: ### -1. Define Project name : ```project_name``` (string ) -2. Choose a location: ```code_loc``` (see [eBird API](https://confluence.cornell.edu/display/CLOISAPI/eBird-1.1-HotSpotsByRegion) for possibility) -3. Choose language : ```lang``` (list of language code, see python code for possibility) -4. Define date of interest : ```byear```, ```eyear```, ```bmonth```, ```emonth``` (begining and end month and year) - -Then ```bird_creator``` fonction will return eBird barchar in a bird list format ```bird_list```. - -### Create Table: ### -1. Define the columns you want to see in your checklist. Here are your possibilities (please, have a look at the code to better understand how to choose each column, the order of input will also be the order in the checklist): - 1. language (English, French, Latin…), - 2. frequency (as a percentage per month, seasons or year), - 3. notes (empty space for comments) and - 4. space (“__” ) to write the number of birds seen or boxes to be ticked. -2. The checklist can create two distinct zones in the checklist: the regular list and the rare list. According to a chosen criteria (e.g: frequency under 1%, does not contain “hybrid”…etc ) birds are displayed either under “regular” (```condition_tableau```), “rare” (```condition_rare```)or none of the lists. The rare list only provides one language and one symbol for each bird. - -Finally, ```write_to_latex``` will create the tex file using ```Template_default.tex``` - -## How to use the web-version ? ## -For the web version, just follow the instruction on [the website](http://zoziologie.raphaelnussbaumer.com/ebirdtolatex/), you won't need any special knowledge. Please let me know if you have any problem or beug! - -If you wish to dive into my code, I'm using Nodejs, python3 and javascript. Javascript get the input for the checklist and send a the info to Nodejs which run the python script on my server and return a link to the pdf generated. +## Where to start? +Have a look at `script_e2L.py` which gives an example with comments on how to use the `e2L` python module. +## Requirement + - python (only python3 has been tested) with a a couple of standard libraries: `requests`,`re`,`lxml` + - latex (`pdflatex`) + - eBird login to download barchart data and your target + ## GIF +Old web version ![Exemple](https://github.com/Zoziologie/ebird2latex/blob/master/assets/e2l.gif?raw=true)