Gitiles
Code Review Sign In
gerrit.named-data.net / ndn-atmos / 4bc4ce82ebcb176376318f0cc24938e5173b58aa
commit4bc4ce82ebcb176376318f0cc24938e5173b58aa[log] [tgz]
authorsusmit shannigrahi <susmit@cs.colostate.edu>Mon Jun 15 12:14:08 2015 -0600
committersusmit shannigrahi <susmit@cs.colostate.edu>Tue Jun 16 11:06:54 2015 -0700
tree2c83fca8ce5900ec9db631f6f5768a90e733053d
parent851e88b2b5f4284dbb40ed9fa289a930fe181418 [diff]
Updating readme

 * Include dependencies required for installation
 * Installation instructions
 * How to run and use the software

 refs: #2889

Change-Id: I44ec3752ba5ff154728b3b587516b3b30798d12d
1 file changed
tree: 2c83fca8ce5900ec9db631f6f5768a90e733053d
  1. .jenkins.d/
  2. .waf-tools/
  3. catalog/
  4. client/
  5. lib/
  6. tools/
  7. .gitignore
  8. .jenkins
  9. .travis.yml
  10. AUTHORS.md
  11. catalog.conf.sample.in
  12. COPYING
  13. README-dev.md
  14. README.md
  15. waf
  16. wscript
README.md

ndn-atmos

This is pre-release software

####If you have trouble running it, drop an email to ndn-sci@netsec.colostate.edu.

This software is designed to support ongoing climate model research at Colorado State University, Berkeley and other institutes. Future plan includes porting this tool to suite other scientific community such as High Energy Particle Physics.

Currently, this software provides an API to publish, query and retrieve scientific datasets using NDN.

Dependencies

The ndn-atmos is built based on several libraries

Dependency for tools and translator library

  • python3
  • netcdf4-python3
  • mysql-connector-python3

The ndn-cxx and ChronoSync need some other prerequisites.

  • For OSX, the prerequisites can be installed using Homebrew:
  • For Ubuntu, use the command below to install the prerequisites:
  • For Fedora, use the command below to install the prerequisites:

Installing ndn-cxx

  • Download ndn-cxx source code. Use the link below for ndn-cxx code:
  • In library folder, build from the source code

Installing ChronoSync

  • Download ChronoSync source code. Use the link below for the ChronoSync code:
  • Build from the source code

Installing ndn-atmos

Follow the steps below to compile and install ndn-atmos:

  • Download the ndn-atmos source code. Use the command below:
  • Build ndn-atmos in the project folder
  • To test ndn-atmos, please use the steps below:
  • Note that you may need to set the LD_LIBRARY_PATH to include the path where the ndn-cxx shared library is installed. For example:

Running ndn-atmos

Install translator library

  1. For the translator, ndn_cmmap_translator library is required to be in PYTHONPATH

Initializing Database

  • Create a database using standard mysql tool.
  • You also need to create a user and set a password to connect to the database the database.
  • Note that you will need to have actual CMIP5 data to run the tool.
  • Run
  • Input full path to the filename and config file to translate
  • A CMIP5 config file is located under
  • This will create a table named cmip5 and insert the names into the table

Starting NFD

NFD is the NDN forwarding daemon.

  • Download NFD source code. Use the link below for the NFD code:
  • Build NFD
  • Run NFD
  • Note that you may need to set the LD_LIBRARY_PATH to include the path where the ndn-cxx shared library is installed. For example:

Launching atmos-catalog

  • Make sure database is initialized and running

  • Create catalog configuration file

  • Edit the configuration file /usr/local/etc/ndn-atmos/catalog.conf. Modify the database parameters in both the queryAdapter and publishAdapter sections.

  • Note that the database parameters in these two sections may be different to provide different privileges.

  • Run ndn-atmos

Starting front end

  • Open the client folder in ndn-atmos

  • Checkout the ndn-js in the client folder. Use the link blow:

  • Start python simple server in the client folder (ndn-atmos/client)
  • Open project query page in a web browser