search

codes-org / codes

The Co-Design of Exascale Storage Architectures (CODES) simulation framework builds upon the ROSS parallel discrete event simulation engine to provide high-performance simulation utilities and models for building scalable distributed systems simulations
Other
40 stars 16 forks source link

Create Broad Documentation #179

Open nmcglo opened 4 years ago

nmcglo commented 4 years ago

One thing that has been lacking from the codebase is a solid spot to start from to create new models and develop additions to the CODES platform.

This is currently on our TODO list but any feedback and questions is helpful. This issue acts as a parent for all discussions regarding development startup questions so that I can make sure that my documentation addresses issues that real users have had.

nmcglo commented 4 years ago

I have begun updating the Wiki. There is now a tutorials section that has a few tutorial like discussions of topics like PDES, ROSS, and Intro to CODES including an installation guide. This will continue to be expanded.

nmcglo commented 4 years ago

I've removed the milestone for this issue as I think it might be good to just leave this issue up to remind anyone that creates new features to go ahead and add documentation. At least until most core CODES stuff has documentation/tutorials.

I've created a new tutorial, too. Creating a synthetic workload generator: Ping Pong traffic model. The tutorial is already on the wiki and the source files that go with it will be merged with #187