Skip to content

Commit

Permalink
Added instructions html file
Browse files Browse the repository at this point in the history
  • Loading branch information
theja authored Dec 21, 2020
1 parent cbf8921 commit f041c3f
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions Instructions.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<h1>Redline Map Generator</h1>


<p>Generates a map in a html file for all the trails in the White Mountain Guide 30th edition. The trails are colored based on the hiked status taken from spreadsheet used to monitor red-lining progress. Read more about red-lining here `http://www.48x12.com/white-mountains-red-lining-objective.shtml`</p>

<h2>Notes</h2>
<p>
<ul>
<li>This works with 29th and 30th edition workbooks</li>
<li>The map has geometries for most of the trails in 30th edition. Some trails in the older 29th edition are missing</li>
<li>If you find any trails missing or geometries to be wrong, please let me know at [email protected]</li>
<li>I won't have access to your spreadsheet or the map that is generated</li>
<li>If your spreadsheet has any sensitive information, I would recommend modifying it before uploading it for security reasons</li>
</ul>
</p>

<h2>Instructions</h2>
<ol>
<li>If you are already in the binder environment, skip to Step 2. Click on <a href="https://mybinder.org/v2/gh/theja/redline_map/master" target="blank"><img src="http://mybinder.org/badge_logo.svg"></a>, or copy an paste the following URL in your browser:
`https://mybinder.org/v2/gh/theja/redline_map/master`. I would recommend opening the binder in a new tab if you want to keep this page open.</li>
<li>
Open the `Input` folder and upload the excel spreadsheet you use for monitoring red-lining progress.
<ul>
<li>The spreadsheet should follow the format of the `Redlining_template.xls` file in the `Input` folder.</li>
<li>The code accounts for some common deviations from the format but it might raise an error sometimes.</li>
<li>If an error is raised due to formatting, I tried to include helpful information in the error message. Adjust the format accordingly and upload the spreadsheet again.</li>
<li>If you don't have the spreadsheet, feel free to download the template and use it to monitor your hiking progress.</li>
<li>You are also welcome to just use the spreadsheet template to build a sample map.</li>
</ul>
</li>
<li>Run the `excel_to_redline_map.ipynb` jupyter notebook and when prompted, enter the name of spreadsheet (e.g. `AMC_30th_Edition_Redlining_v30_9.xls`) with the correct extension (.xls or .xlsx).</li>
<li>Output will be saved as a HTML file in the `Output` folder. You can download the file and use it as you please.</li>
<li>The map generated will have all the trails that are completely hiked in red and everything else in blue.</li>
</ol>

<h2>Acknowledgments</h2>
<p>I would like to thank Beth Zimmer, Andreas Frese and others in the red-lining community for providing gps tracks of trails used here. Thank you to all those involved in making the spreadsheet template that most of us use to keep track of our hiking progress. My gratitude goes to all those who maintain the trails we enjoy and those involved in making the White mountain Guide possible.</p>

0 comments on commit f041c3f

Please sign in to comment.