Code Monkey home page Code Monkey logo

scipy-lectures.github.com's Introduction


<!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>Contents &mdash; Scipy lecture notes</title>
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
        VERSION:     '2011',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </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="top" title="Scipy lecture notes" href="index.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li><a href="index.html">Scipy lecture notes</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
          <div class="body">
            
  <div class="section" id="contents">
<h1>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h1>
<p>This repository gathers some lecture notes on the scientific Python ecosystem.
They have been initially used in the intro (and some advanced) tutorials at
Euroscipy 2010.</p>
<p>These documents are written with the rest markup language (.rst
extension) and built using Sphinx.</p>
</div>
<div class="section" id="reusing-and-distributing">
<h1>Reusing and distributing<a class="headerlink" href="#reusing-and-distributing" title="Permalink to this headline">¶</a></h1>
<p>As stated in the LICENSE.txt file, this material comes with no strings
attached. Feel free to reuse and modify for your own teaching purposes.</p>
<p>However, we would like this reference material to be improved over time,
thus we encourage people to contribute back changes. These will be
reviewed and edited by the original authors.</p>
</div>
<div class="section" id="building-instructions">
<h1>Building instructions<a class="headerlink" href="#building-instructions" title="Permalink to this headline">¶</a></h1>
<p>To generate the html output for on-screen display, Type:</p>
<div class="highlight-python"><pre>make html</pre>
</div>
<p>the generated html files can be found in <cite>build/html</cite></p>
<p>To generate the pdf file for printing:</p>
<div class="highlight-python"><pre>make pdf</pre>
</div>
<p>The pdf builder is a pointy and you might have some TeX errors. Tweaking
the layout in the rst files is usually enough to work around these
problems.</p>
</div>
<div class="section" id="requirements">
<h1>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h1>
<p><em>probably incomplete</em></p>
<ul class="simple">
<li>make</li>
<li>sphinx :) (&gt;= 1.0)</li>
<li>pdflatex</li>
<li>pdfjam</li>
<li>matplotlib</li>
<li>scikits.learn (&gt;= 0.8 ?)</li>
</ul>
</div>
<div class="section" id="editorial-policy">
<h1>Editorial policy<a class="headerlink" href="#editorial-policy" title="Permalink to this headline">¶</a></h1>
<p>The goal of this material is to provide a concise text useful to
learning the main features of the scipy ecosystem. If you want
to contribute to reference material, we suggest that you contribute
the the documentation of the specific packages that you are
interested in.</p>
<p>The HTML output can be used for displaying on screen while
teaching. The goal is to have the same material displayed as
in the notes. This is why the HTML version should be kept concise, with
bullet-lists rather than full-blown paragraphs and sentences.
In the long run, we would like to build more elaborate discussions. For this,
the policy is to use the:</p>
<div class="highlight-python"><pre>.. only:: pdf</pre>
</div>
<p>sphinx directive.</p>
</div>
<div class="section" id="modifying">
<h1>Modifying<a class="headerlink" href="#modifying" title="Permalink to this headline">¶</a></h1>
<p>The easiest way to make your own version of this teaching material
is to fork it under Github, and use the git version control system to
maintain your own fork. For this, all you have to do is create an account
on github (this site) and click on the <cite>fork</cite> button, on the top right of this
page. You can use git to pull from your <cite>fork</cite>, and push back to it the
changes. If you want to contribute the changes back, just fill a <cite>pull request</cite>,
using the button on the top of your fork&#8217;s page.</p>
<p>Please refrain from modifying the Makefile unless it is absolutely
necessary. The figure should be generated from Python source files and
rst files using the plot directive Sphinx extension.</p>
</div>


          </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li><a href="index.html">Scipy lecture notes</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2011.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.
    </div>
  </body>
</html>

scipy-lectures.github.com's People

Contributors

gaelvaroquaux avatar

Stargazers

avatar

Watchers

avatar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.