Skip to content

Commit

Permalink
Update user and developer documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
martinholmer committed Feb 14, 2018
1 parent ddb20dc commit 453ee45
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 15 deletions.
22 changes: 15 additions & 7 deletions docs/index.html
Expand Up @@ -41,6 +41,15 @@ <h2 id="whatsnew">What's New</h2>
than an older version that your browser has saved in its cache of
previously visited pages.</i></p>

<p><a href="https://github.com/open-source-economics/Tax-Calculator/blob/master/RELEASES.md#2018-02-13-release-0160">New CPS data</a> include several
cash and in-kind benefit amounts, the consumption value of which are
included in expanded income, in Tax-Calculator release 0.16.0 and
higher

<p><a href="https://github.com/open-source-economics/Tax-Calculator/blob/master/RELEASES.md#2018-02-13-release-0160">New PUF data</a> for 2011, which produce
slightly different results than the old 2009 PUF data produced, in
Tax-Calculator release 0.16.0 and higher

<p><a href="https://github.com/open-source-economics/Tax-Calculator/blob/master/taxcalc/reforms/2017_law.json">Pre-TCJA policy reform file</a> is available
given that TCJA is current-law policy in Tax-Calculator release 0.15.0
and higher
Expand Down Expand Up @@ -240,9 +249,9 @@ <h3 id="cli-install-test">Install/Test tc CLI</h3>

<p><b>Install the free Anaconda Python distribution</b> by going to
the <a href="https://www.continuum.io/downloads">Continuum Analytics
download page</a> and selecting a version of Python. You can install
either Python 2.7 or Python 3.6 because we test Tax-Calculator with
both. You must do this installation even if you already
download page</a> and selecting a version of Python. You should install
Python 3.6 because we will be forced to discontinue support for Python
2.7 at the end of 2018. You must do this installation even if you already
have Python installed on your computer because the Anaconda
distribution contains all the additional Python packages that
Tax-Calculator uses to conduct tax calculations (many of which are not
Expand All @@ -259,10 +268,9 @@ <h3 id="cli-install-test">Install/Test tc CLI</h3>
<pre>$ conda --version</pre>
Expected output is something like <kbd>conda 4.4.7</kbd>
<pre>$ python --version</pre>
Expected output should contain either the <kbd>Python 2.7</kbd> or
the <kbd>Python 3.6</kbd> phrase as well as the
<kbd>Anaconda</kbd> phrase, the presence of which confirm that the
installation went smoothly.
Expected output should contain the <kbd>Python 3.6</kbd> phrase as
well as the <kbd>Anaconda</kbd> phrase, the presence of which confirm
that the installation went smoothly.</p>

<p><b>Install the free taxcalc package</b> by entering the following:
<pre>$ conda install -c ospc taxcalc</pre>
Expand Down
22 changes: 15 additions & 7 deletions docs/index.htmx
Expand Up @@ -40,6 +40,15 @@ ensure you are viewing the most recent version of this page rather
than an older version that your browser has saved in its cache of
previously visited pages.</i></p>

<p><a href="https://github.com/open-source-economics/Tax-Calculator/blob/master/RELEASES.md#2018-02-13-release-0160">New CPS data</a> include several
cash and in-kind benefit amounts, the consumption value of which are
included in expanded income, in Tax-Calculator release 0.16.0 and
higher

<p><a href="https://github.com/open-source-economics/Tax-Calculator/blob/master/RELEASES.md#2018-02-13-release-0160">New PUF data</a> for 2011, which produce
slightly different results than the old 2009 PUF data produced, in
Tax-Calculator release 0.16.0 and higher

<p><a href="https://github.com/open-source-economics/Tax-Calculator/blob/master/taxcalc/reforms/2017_law.json">Pre-TCJA policy reform file</a> is available
given that TCJA is current-law policy in Tax-Calculator release 0.15.0
and higher
Expand Down Expand Up @@ -239,9 +248,9 @@ files to TaxBrain.</p>

<p><b>Install the free Anaconda Python distribution</b> by going to
the <a href="https://www.continuum.io/downloads">Continuum Analytics
download page</a> and selecting a version of Python. You can install
either Python 2.7 or Python 3.6 because we test Tax-Calculator with
both. You must do this installation even if you already
download page</a> and selecting a version of Python. You should install
Python 3.6 because we will be forced to discontinue support for Python
2.7 at the end of 2018. You must do this installation even if you already
have Python installed on your computer because the Anaconda
distribution contains all the additional Python packages that
Tax-Calculator uses to conduct tax calculations (many of which are not
Expand All @@ -258,10 +267,9 @@ in any directory:
<pre>$ conda --version</pre>
Expected output is something like <kbd>conda 4.4.7</kbd>
<pre>$ python --version</pre>
Expected output should contain either the <kbd>Python 2.7</kbd> or
the <kbd>Python 3.6</kbd> phrase as well as the
<kbd>Anaconda</kbd> phrase, the presence of which confirm that the
installation went smoothly.
Expected output should contain the <kbd>Python 3.6</kbd> phrase as
well as the <kbd>Anaconda</kbd> phrase, the presence of which confirm
that the installation went smoothly.</p>

<p><b>Install the free taxcalc package</b> by entering the following:
<pre>$ conda install -c ospc taxcalc</pre>
Expand Down
2 changes: 1 addition & 1 deletion read-the-docs/source/contributor_guide.rst
Expand Up @@ -18,7 +18,7 @@ Setup Python
-------------

The Tax-Calculator is written in the Python programming language.
Download and install the free Anaconda distribution of Python from
Download and install the free Anaconda distribution of Python 3.6 from
`Continuum Analytics`_. You must do this even if you already have
Python installed on your computer because the Anaconda distribution
contains all the additional Python packages that we use to conduct tax
Expand Down

0 comments on commit 453ee45

Please sign in to comment.