Difference between revisions of "App Store Technical Requirements"

From Nsnam
Jump to: navigation, search
(Created page with 'The basic idea of the ns-3 app store would be to store on a server a set of user-submitted metadata which describes various source code packages. Typical metadata would include: …')
 
(app store requirements)
Line 1: Line 1:
 +
{{TOC}}
 +
 +
= Requirements =
 +
 +
Devise a new source code organization, build system, and package management (metadata and scripts) system that provides the following:
 +
* ns-3-dev continues to contain the core models, test suites, and documentation that are actively maintained by the project and built by all users
 +
* ns-3-models contains additional models that can be added to the build with user-friendly build instructions.  There will be two classifications:
 +
** ''maintained:'' These contain models that are actively maintained by the project.  All models in this directory are checked for each release, and bugs in tracker are responded to
 +
** ''unmaintained:'' These contain models that conform to the package metadata system, but the project does not do any testing or maintenance of them.  They may fall out of date over time.  They may be revived in the future and added to the maintained status.
 +
* models can also be stored at external web sites; such models will typically have "unmaintained" status.  Note that "unmaintained" means unmaintained by the project; someone may be actively maintaining them behind the scenes.
 +
 
The basic idea of the ns-3 app store would be to store on a server a set of user-submitted metadata which describes various source code packages. Typical metadata would include:
 
The basic idea of the ns-3 app store would be to store on a server a set of user-submitted metadata which describes various source code packages. Typical metadata would include:
* name
+
* unique name
 
* version number
 
* version number
 +
* last known good ns-3 version (tested against)
 
* description
 
* description
 
* download url
 
* download url
Line 7: Line 19:
 
* configure command
 
* configure command
 
* build command
 
* build command
* list of dependencies (other packages which this package depends upon)
+
* system prerequisites (if user needs to apt-get install other libraries)
 +
* list of ns-3 package dependencies (other ns-3 packages which this package depends upon)
  
 
Then, if the user wants to get the wimax module, he would do something like this on his machine:
 
Then, if the user wants to get the wimax module, he would do something like this on his machine:
Line 15: Line 28:
 
nsdep setup wimax
 
nsdep setup wimax
 
nsdep build wimax
 
nsdep build wimax
 +
nsdep install wimax # install wimax module, headers, and tests to ns-3 directory somewhere

Revision as of 21:48, 28 April 2010

Main Page - Current Development - Developer FAQ - Tools - Related Projects - Project Ideas - Summer Projects

Installation - Troubleshooting - User FAQ - HOWTOs - Samples - Models - Education - Contributed Code - Papers

Requirements

Devise a new source code organization, build system, and package management (metadata and scripts) system that provides the following:

  • ns-3-dev continues to contain the core models, test suites, and documentation that are actively maintained by the project and built by all users
  • ns-3-models contains additional models that can be added to the build with user-friendly build instructions. There will be two classifications:
    • maintained: These contain models that are actively maintained by the project. All models in this directory are checked for each release, and bugs in tracker are responded to
    • unmaintained: These contain models that conform to the package metadata system, but the project does not do any testing or maintenance of them. They may fall out of date over time. They may be revived in the future and added to the maintained status.
  • models can also be stored at external web sites; such models will typically have "unmaintained" status. Note that "unmaintained" means unmaintained by the project; someone may be actively maintaining them behind the scenes.

The basic idea of the ns-3 app store would be to store on a server a set of user-submitted metadata which describes various source code packages. Typical metadata would include:

  • unique name
  • version number
  • last known good ns-3 version (tested against)
  • description
  • download url
  • untar/unzip command
  • configure command
  • build command
  • system prerequisites (if user needs to apt-get install other libraries)
  • list of ns-3 package dependencies (other ns-3 packages which this package depends upon)

Then, if the user wants to get the wimax module, he would do something like this on his machine: mkdir tmp cd tmp nsdep download wimax # download all packages which wimax depends on too nsdep setup wimax nsdep build wimax nsdep install wimax # install wimax module, headers, and tests to ns-3 directory somewhere