Giter VIP home page Giter VIP logo

tracpy's Introduction

TracPy

Fortran core of TRACMASS + Python wrapping around the outside.

To get the code

  1. Make your new TracPy directory and change directories into it.
  2. Clone the TracPy repository from GitHub. In the command prompt, type: git clone https://github.com/kthyng/tracpy.git
  3. Install the package. pip install -e . This makes the package an editable install so that it can be updated with future additions to TracPy. Note that a required package is octant.

To update the code later

  1. Move into your TracPy directory.
  2. Update your GitHub repository. git pull
  3. Edit your install of TracPy. pip install -e . or pip install --force-reinstall -e .

To test the code

  1. After making changes to the code, you can do some basic functionality testing with py.test or nosetests in the tests subdirectory.

To learn more about the module TracPy

Learn more by running a small test case. Internet required.

  1. Open an iPython notebook server in the TracPy docs directory. ipython notebook
  2. A webpage will open in your browser showing the available notebooks in the current directory. Open the notebook called manual.
  3. The cells of the notebook can be run in order by pushing "shift" and "enter" together or the whole notebook can be run by selecting Cell > Run all. The notebook demonstrates how to initialize and run a numerical drifter experiment using TracPy.
  4. Alternatively, a static PDF version of the manual can be viewed at http://nbviewer.ipython.org/urls/raw.github.com/kthyng/tracpy/master/docs/manual.ipynb.

To run your own projects

For projects, it is suggested to start a separate directory with its own initialization and run file for the simulation(s). Then TracPy can be imported as a module and the run script can be run from the project. An example set of projects can be found at https://github.com/kthyng/gisr.git.

To learn more about TRACMASS

  • Döös, K., Kjellsson, J., & Jönsson, B. (2013). TRACMASS—A Lagrangian Trajectory Model. In Preventive Methods for Coastal Protection (pp. 225-249). Springer International Publishing.
  • Döös, K., Rupolo, V., & Brodeau, L. (2011). Dispersion of surface drifters and model-simulated trajectories. Ocean Modelling, 39(3), 301-310.
  • Döös, K., & Engqvist, A. (2007). Assessment of water exchange between a discharge region and the open sea–A comparison of different methodological concepts. Estuarine, Coastal and Shelf Science, 74(4), 709-721.
  • TRACMASS on GitHub: https://github.com/TRACMASS

tracpy's People

Contributors

kthyng avatar chrisbarker-noaa avatar dcherian avatar

Watchers

Jonathan Beezley avatar Aashish Chaudhary avatar David E DeMarle avatar James Cloos avatar Chris Harris 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.