Changeset 9717
- Timestamp:
- Mar 23, 2015, 12:06:03 PM (10 years ago)
- Location:
- trunk/anuga_core
- Files:
-
- 5 edited
-
CONTRIBUTING.rst (modified) (6 diffs)
-
INSTALL.rst (modified) (4 diffs)
-
README.rst (modified) (8 diffs)
-
tools/install_conda.sh (modified) (1 diff)
-
tools/install_ubuntu.sh (modified) (2 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/anuga_core/CONTRIBUTING.rst
r9640 r9717 1 1 2 ================= 2 3 Contributing code 3 4 ================= 4 5 5 6 The preferred way to contribute to anuga is to fork the 6 [main repository](http://github.com/stoiver/anuga_core/) on 7 GitHub: 7 `main repository <http://github.com/stoiver/anuga_core>`_ on GitHub: 8 8 9 1. Fork the [project repository](http://github.com/stoiver/anuga_core):9 1. Fork the `project repository <http://github.com/GeoscienceAustralia/anuga_core>`_: 10 10 click on the 'Fork' button near the top of the page. This creates 11 11 a copy of the code under your account on the GitHub server. 12 12 13 2. Clone this copy to your local disk: 13 2. Clone this copy to your local disk:: 14 14 15 15 $ git clone git@github.com:YourLogin/anuga_core.git 16 16 $ cd anuga_core 17 17 18 3. Create a branch to hold your changes: 18 3. Create a branch to hold your changes:: 19 19 20 20 $ git checkout -b my-feature … … 23 23 24 24 4. Work on this copy on your computer using Git to do the version 25 control. When you're done editing, do: 25 control. When you're done editing, do:: 26 26 27 27 $ git add modified_files 28 28 $ git commit 29 29 30 to record your changes in Git, then push them to GitHub with: 30 to record your changes in Git, then push them to GitHub with:: 31 31 32 32 $ git push -u origin my-feature … … 37 37 38 38 (If any of the above seems like magic to you, then look up the 39 [Git documentation](http://git-scm.com/documentation)on the web.)39 `Git documentation <http://git-scm.com/documentation>`_ on the web.) 40 40 41 41 It is recommended to check that your contribution complies with the … … 46 46 47 47 - All other tests pass when everything is rebuilt from scratch. On 48 Unix-like systems, check with (from the toplevel source folder): 48 Unix-like systems, check with (from the toplevel source folder):: 49 49 50 50 $ make … … 62 62 tools: 63 63 64 - Code with good unittest coverage (at least 80%), check with: 64 - Code with good unittest coverage (at least 80%), check with:: 65 65 66 66 $ pip install nose coverage 67 67 $ nosetests --with-coverage path/to/tests_for_package 68 68 69 - No pyflakes warnings, check with: 69 - No pyflakes warnings, check with:: 70 70 71 71 $ pip install pyflakes 72 72 $ pyflakes path/to/module.py 73 73 74 - No PEP8 warnings, check with: 74 - No PEP8 warnings, check with:: 75 75 76 76 $ pip install pep8 77 77 $ pep8 path/to/module.py 78 78 79 - AutoPEP8 can help you fix some of the easy redundant errors: 79 - AutoPEP8 can help you fix some of the easy redundant errors:: 80 80 81 81 $ pip install autopep8 … … 90 90 91 91 A great way to start contributing to anuga is to pick an item 92 from the list of [Easy issues](https://github.com/stoiver/anuga_core/issues?labels=Easy)92 from the list of `Easy issues <https://github.com/GeoscienceAustralia/anuga_core/issues?labels=Easy>`_ 93 93 in the issue tracker. (Well there are none there yet, but we will be 94 94 putting some up soon!) Resolving these issues allow you to start -
trunk/anuga_core/INSTALL.rst
r9688 r9717 15 15 If you have a python 2.7 environment with gcc and gfortran support, 16 16 then you can use pip to install the latest release 17 version of AnuGA. 17 version of AnuGA:: 18 19 pip install anuga 18 20 19 21 20 21 Installing from source 22 ---------------------- 23 24 If you download a source distribution of AnuGA_ you will find a bash script 25 ``install_packages.sh`` in the ``tools`` directory which will install Miniconda_ 26 along with a Miniconda environment ``anuga_env`` with all the appropriate 27 packages installed. You will have to add 28 29 export GDAL_DATA=`gdal-config --datadir` 30 31 to your .bashrc file to avoid some annoying error messages. 32 33 From the ``anuga_core`` directory then run 34 35 python setup.py install 36 37 And then 38 39 python runtests.py 40 41 to check the installation. 42 43 44 Manually installing the dependencies 45 ------------------------------------ 22 Dependencies 23 ------------ 46 24 47 25 AnuGA requires the following packages: … … 54 32 * `nose <http://nose.readthedocs.org/en/latest/>`_ 55 33 * A C compiler (preferably GCC or TDM-GCC_ MinGW_ on Windows) 34 35 36 56 37 57 38 The easiest and **preferred** way to get all dependencies in the latest … … 146 127 you can install AnuGA directly from Github_. 147 128 We try to maintain the *master* branch stable and 148 `passing all tests <https://travis-ci.org/ stoiver/anuga_core/branches>`__,129 `passing all tests <https://travis-ci.org/GeoscienceAustralia/anuga_core/branches>`__, 149 130 so it should be safe to use. 150 131 … … 152 133 Then, open a terminal and run:: 153 134 154 git clone --depth=50 --branch=master git://github.com/stoiver/anuga_core.git135 git clone git://github.com/GeoscienceAustralia/anuga_core.git 155 136 156 137 This will fetch the source code from Github_ -
trunk/anuga_core/README.rst
r9713 r9717 1 .. image:: https://travis-ci.org/ stoiver/anuga_core.svg?branch=master2 :target: https://travis-ci.org/ stoiver/anuga_core1 .. image:: https://travis-ci.org/GeoscienceAustralia/anuga_core.svg?branch=master 2 :target: https://travis-ci.org/GeoscienceAustralia/anuga_core 3 3 4 .. image:: https://coveralls.io/repos/ stoiver/anuga_core/badge.svg?branch=master5 :target: https://coveralls.io/r/ stoiver/anuga_core?branch=master4 .. image:: https://coveralls.io/repos/GeoscienceAustralia/anuga_core/badge.svg?branch=master 5 :target: https://coveralls.io/r/GeoscienceAustralia/anuga_core?branch=master 6 6 7 7 .. image:: https://pypip.in/version/anuga/badge.svg?style=flat … … 35 35 36 36 37 Copyright 2004 , 2005, 2006,201537 Copyright 2004 - 2015 38 38 Ole Nielsen, Stephen Roberts, Duncan Gray, Jane Sexton, Gareth Davies 39 39 … … 43 43 44 44 For installation instructions, see 45 `INSTALL.rst <https://github.com/ stoiver/anuga_core/blob/master/INSTALL.rst>`_45 `INSTALL.rst <https://github.com/GeoscienceAustralia/anuga_core/blob/master/INSTALL.rst>`_ 46 46 47 47 … … 50 50 51 51 AnuGA documentation is available in the doc folder. In particular the 52 `user_manual <https://github.com/ stoiver/anuga_core/raw/master/doc/anuga_user_manual.pdf>`_52 `user_manual <https://github.com/GeoscienceAustralia/anuga_core/raw/master/doc/anuga_user_manual.pdf>`_ 53 53 54 54 Also helpful information is available noline at … … 78 78 The latest development version of AnuGA's sources are is available at: 79 79 80 https://github.com/ stoiver/anuga_core80 https://github.com/GeoscienceAustralia/anuga_core 81 81 82 82 They can be downloaded as a zip file or using the Git client. … … 88 88 To search for bugs or report them, please use the AnuGA's Bug Tracker at: 89 89 90 https://github.com/ stoiver/anuga_core/issues90 https://github.com/GeoscienceAustralia/anuga_core/issues 91 91 92 92 … … 95 95 96 96 If you would like to take part in AnuGA development, take a look 97 at `CONTRIBUTING.rst <https://github.com/ stoiver/anuga_core/blob/master/CONTRIBUTING.rst>`_.97 at `CONTRIBUTING.rst <https://github.com/GeoscienceAustralia/anuga_core/blob/master/CONTRIBUTING.rst>`_. 98 98 99 99 … … 101 101 ------------------- 102 102 103 See the file `LICENSE.txt <https://github.com/ stoiver/anuga_core/blob/master/LICENCE.txt>`_103 See the file `LICENSE.txt <https://github.com/GeoscienceAustralia/anuga_core/blob/master/LICENCE.txt>`_ 104 104 for information on the history of this software, terms & conditions for usage, 105 105 and a DISCLAIMER OF ALL WARRANTIES. -
trunk/anuga_core/tools/install_conda.sh
r9714 r9717 15 15 16 16 sudo apt-get update -q 17 sudo apt-get install gfortran 17 sudo apt-get install gfortran git 18 18 19 19 ########################################################## -
trunk/anuga_core/tools/install_ubuntu.sh
r9714 r9717 18 18 # Use standard ubuntu packages in their default version 19 19 20 sudo apt-get install -q -y gfortran python-dev python-numpy python-scipy \ 20 sudo apt-get install -q -y git gfortran python-dev python-numpy \ 21 python-scipy \ 21 22 python-matplotlib netcdf-bin \ 22 23 libnetcdf-dev libhdf5-serial-dev \ 23 24 python-gdal python-pip 24 25 25 sudo pip install nose netCDF4 pyproj 26 # At present netCDF4==1.1.7 produces an error 27 sudo pip install nose netCDF4==1.1.6 pyproj 26 28 27 29 ########################################################## … … 37 39 # Install pypar if parallel set 38 40 if [[ "$ANUGA_PARALLEL" == "mpich2" || "$ANUGA_PARALLEL" == "openmpi" ]]; then 39 svn checkout https://github.com/daleroberts/pypar/trunk pypar;41 git clone https://github.com/daleroberts/pypar.git; 40 42 pushd pypar; 41 43 python setup.py build;
Note: See TracChangeset
for help on using the changeset viewer.
