Skip to content

Pandas set up instruction #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 13, 2018
Merged

Pandas set up instruction #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9354c49
adding pandas setup
SandrineP Feb 8, 2018
6eb4a1f
Merge branch 'master' of https://github.com/SandrineP/python-sprints.…
SandrineP Feb 8, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions pandas/guide/_sources/pandas_setup.rst.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
Instructions for Pandas Sprints
*******************************

The project
===========
`pandas <https://pandas.pydata.org/>`_ is an open source, BSD-licensed library providing high-performance, easy-to-use data structures and data analysis tools for the Python programming language.

pandas is a `NumFOCUS <https://www.numfocus.org/sponsored-projects/>`_ sponsored project. This will help ensure the success of development of pandas as a world-class open-source project, and makes it possible to `donate <https://pandas.pydata.org/donate.html>`_ to the project.


Set up for the sprint
=====================

Make sure you **bring your own laptop** to the sprint.

You need the next softwares installed:

* Git
* An editor (vim, emacs, PyCharm,...)

To **set up the environment**, you have detailed instructions in the `pandas contributing guide <https://pandas.pydata.org/pandas-docs/stable/contributing.html>`_.

Create an account on Github github.com

Get the pandas source code:

* Fork the `pandas project <https://github.com/pandas-dev/pandas>`_ on GitHub (click on the top-right fork button)
* In the terminal, run:
``git clone https://github.com/<your-github-username>/pandas``

A summary of it would be:

* Download and install `Anaconda <https://www.anaconda.com/download/#linux>`_
* Activate conda by one of the next (or equivalent, if you know what you're doing):
| Restart your terminal
| ``. ~/.bashrc``
| ``export PATH="<path-to-anaconda>/bin:$PATH"``
* Create a conda environment:
``conda create -n pandas_dev -f <path-to-pandas>/ci/environment-dev.yaml``
* Activate the new conda environment:
``source activate pandas_dev``
* Install pandas development dependencies:
``conda install -c defaults -c conda-forge --file=<path-to-pandas>/ci/requirements-optional-conda.txt``
* Compile C code in pandas:
| ``python setup.py build_ext --inplace``
| Run the tests:
| ``cd <path-to-pandas>``
| ``pytest pandas``
7 changes: 0 additions & 7 deletions pandas/guide/_static/basic.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,13 +398,6 @@ table.field-list td, table.field-list th {
margin: 0;
}

.field-name {
-moz-hyphens: manual;
-ms-hyphens: manual;
-webkit-hyphens: manual;
hyphens: manual;
}

/* -- other body styles ----------------------------------------------------- */

ol.arabic {
Expand Down
23 changes: 13 additions & 10 deletions pandas/guide/contents.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>How to write a good pandas docstring &#8212; Python documentation</title>

<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
Expand All @@ -30,7 +33,7 @@
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head>
<body>
<body role="document">


<div class="document">
Expand Down Expand Up @@ -218,9 +221,9 @@ <h3>Section 2: Extended summary<a class="headerlink" href="#section-2-extended-s
<div class="section" id="section-3-parameters">
<h3>Section 3: Parameters<a class="headerlink" href="#section-3-parameters" title="Permalink to this headline">¶</a></h3>
<p>The details of the parameters will be added in this section. This section has
the title “Parameters”, followed by a line with a hyphen under each letter of
the word “Parameters”. A blank line is left before the section title, but not
after, and not between the line with the word “Parameters” and the one with
the title &#8220;Parameters&#8221;, followed by a line with a hyphen under each letter of
the word &#8220;Parameters&#8221;. A blank line is left before the section title, but not
after, and not between the line with the word &#8220;Parameters&#8221; and the one with
the hyphens.</p>
<p>After the title, each parameter in the signature must be documented, including
<cite>*args</cite> and <cite>**kwargs</cite>, but not <cite>self</cite>.</p>
Expand Down Expand Up @@ -296,7 +299,7 @@ <h4>Parameter types<a class="headerlink" href="#parameter-types" title="Permalin
and separated by commas (followed by a space):</p>
<ul class="simple">
<li>{0, 10, 25}</li>
<li>{‘simple’, ‘advanced’}</li>
<li>{&#8216;simple&#8217;, &#8216;advanced&#8217;}</li>
</ul>
<p>If the type is defined in a Python module, the module must be specified:</p>
<ul class="simple">
Expand All @@ -315,7 +318,7 @@ <h4>Parameter types<a class="headerlink" href="#parameter-types" title="Permalin
<li>pandas.DataFrame</li>
</ul>
<p>If more than one type is accepted, separate them by commas, except the
last two types, that need to be separated by the word ‘or’:</p>
last two types, that need to be separated by the word &#8216;or&#8217;:</p>
<ul class="simple">
<li>int or float</li>
<li>float, decimal.Decimal or None</li>
Expand All @@ -327,8 +330,8 @@ <h4>Parameter types<a class="headerlink" href="#parameter-types" title="Permalin
<h3>Section 4: Returns or Yields<a class="headerlink" href="#section-4-returns-or-yields" title="Permalink to this headline">¶</a></h3>
<p>If the method returns a value, it will be documented in this section. Also
if the method yields its output.</p>
<p>The title of the section will be defined in the same way as the “Parameters”.
With the names “Returns” or “Yields” followed by a line with as many hyphens
<p>The title of the section will be defined in the same way as the &#8220;Parameters&#8221;.
With the names &#8220;Returns&#8221; or &#8220;Yields&#8221; followed by a line with as many hyphens
as the letters in the preceding word.</p>
<p>The documentation of the return is also similar to the parameters. But in this
case, no name will be provided, unless the method returns or yields more than
Expand Down Expand Up @@ -431,7 +434,7 @@ <h3>Quick search</h3>
&copy;.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.5.6</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>

|
Expand Down
9 changes: 6 additions & 3 deletions pandas/guide/genindex.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@


<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Index &#8212; Python documentation</title>

<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
Expand All @@ -31,7 +34,7 @@
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head>
<body>
<body role="document">


<div class="document">
Expand Down Expand Up @@ -82,7 +85,7 @@ <h3>Quick search</h3>
&copy;.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.5.6</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>

</div>
Expand Down
Binary file modified pandas/guide/objects.inv
View file
Open in desktop
Binary file not shown.
178 changes: 178 additions & 0 deletions pandas/guide/pandas_setup.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,178 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Instructions for Pandas Sprints &#8212; Python documentation</title>

<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />

<link rel="stylesheet" href="_static/custom.css" type="text/css" />


<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head>
<body role="document">


<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">

<div class="section" id="instructions-for-pandas-sprints">
<h1>Instructions for Pandas Sprints<a class="headerlink" href="#instructions-for-pandas-sprints" title="Permalink to this headline">¶</a></h1>
<div class="section" id="the-project">
<h2>The project<a class="headerlink" href="#the-project" title="Permalink to this headline">¶</a></h2>
<p><a class="reference external" href="https://pandas.pydata.org/">pandas</a> is an open source, BSD-licensed library providing high-performance, easy-to-use data structures and data analysis tools for the Python programming language.</p>
<p>pandas is a <a class="reference external" href="https://www.numfocus.org/sponsored-projects/">NumFOCUS</a> sponsored project. This will help ensure the success of development of pandas as a world-class open-source project, and makes it possible to <a class="reference external" href="https://pandas.pydata.org/donate.html">donate</a> to the project.</p>
</div>
<div class="section" id="set-up-for-the-sprint">
<h2>Set up for the sprint<a class="headerlink" href="#set-up-for-the-sprint" title="Permalink to this headline">¶</a></h2>
<p>Make sure you <strong>bring your own laptop</strong> to the sprint.</p>
<p>You need the next softwares installed:</p>
<ul class="simple">
<li>Git</li>
<li>An editor (vim, emacs, PyCharm,...)</li>
</ul>
<p>To <strong>set up the environment</strong>, you have detailed instructions in the <a class="reference external" href="https://pandas.pydata.org/pandas-docs/stable/contributing.html">pandas contributing guide</a>.</p>
<p>Create an account on Github github.com</p>
<p>Get the pandas source code:</p>
<ul class="simple">
<li>Fork the <a class="reference external" href="https://github.com/pandas-dev/pandas">pandas project</a> on GitHub (click on the top-right fork button)</li>
<li><dl class="first docutils">
<dt>In the terminal, run:</dt>
<dd><code class="docutils literal"><span class="pre">git</span> <span class="pre">clone</span> <span class="pre">https://github.com/&lt;your-github-username&gt;/pandas</span></code></dd>
</dl>
</li>
</ul>
<p>A summary of it would be:</p>
<ul>
<li><p class="first">Download and install <a class="reference external" href="https://www.anaconda.com/download/#linux">Anaconda</a></p>
</li>
<li><dl class="first docutils">
<dt>Activate conda by one of the next (or equivalent, if you know what you&#8217;re doing):</dt>
<dd><div class="first last line-block">
<div class="line">Restart your terminal</div>
<div class="line"><code class="docutils literal"><span class="pre">.</span> <span class="pre">~/.bashrc</span></code></div>
<div class="line"><code class="docutils literal"><span class="pre">export</span> <span class="pre">PATH=&quot;&lt;path-to-anaconda&gt;/bin:$PATH&quot;</span></code></div>
</div>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Create a conda environment:</dt>
<dd><p class="first last"><code class="docutils literal"><span class="pre">conda</span> <span class="pre">create</span> <span class="pre">-n</span> <span class="pre">pandas_dev</span> <span class="pre">-f</span> <span class="pre">&lt;path-to-pandas&gt;/ci/environment-dev.yaml</span></code></p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Activate the new conda environment:</dt>
<dd><p class="first last"><code class="docutils literal"><span class="pre">source</span> <span class="pre">activate</span> <span class="pre">pandas_dev</span></code></p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Install pandas development dependencies:</dt>
<dd><p class="first last"><code class="docutils literal"><span class="pre">conda</span> <span class="pre">install</span> <span class="pre">-c</span> <span class="pre">defaults</span> <span class="pre">-c</span> <span class="pre">conda-forge</span> <span class="pre">--file=&lt;path-to-pandas&gt;/ci/requirements-optional-conda.txt</span></code></p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Compile C code in pandas:</dt>
<dd><div class="first last line-block">
<div class="line"><code class="docutils literal"><span class="pre">python</span> <span class="pre">setup.py</span> <span class="pre">build_ext</span> <span class="pre">--inplace</span></code></div>
<div class="line">Run the tests:</div>
<div class="line"><code class="docutils literal"><span class="pre">cd</span> <span class="pre">&lt;path-to-pandas&gt;</span></code></div>
<div class="line"><code class="docutils literal"><span class="pre">pytest</span> <span class="pre">pandas</span></code></div>
</div>
</dd>
</dl>
</li>
</ul>
</div>
</div>


</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="contents.html">
<img class="logo" src="_static/logo.png" alt="Logo"/>
</a></p>
<h3><a href="contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Instructions for Pandas Sprints</a><ul>
<li><a class="reference internal" href="#the-project">The project</a></li>
<li><a class="reference internal" href="#set-up-for-the-sprint">Set up for the sprint</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="contents.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/pandas_setup.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.5.6</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>

|
<a href="_sources/pandas_setup.rst.txt"
rel="nofollow">Page source</a>
</div>




</body>
</html>
9 changes: 6 additions & 3 deletions pandas/guide/search.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Search &#8212; Python documentation</title>

<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
Expand Down Expand Up @@ -38,7 +41,7 @@


</head>
<body>
<body role="document">


<div class="document">
Expand Down Expand Up @@ -92,7 +95,7 @@ <h3>Related Topics</h3>
&copy;.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.5.6</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>

</div>
Expand Down
Loading