Difference between revisions of "Deuces"

From BRL-CAD
(expand out volume, centroid, and surface area tasks, pulled from latest source status (with the more complex ones removed))
m (Implement a primitive curvature function)
 
(131 intermediate revisions by 18 users not shown)
Line 1: Line 1:
This is a list of really quick projects that are expected to take less than two hours to complete.  It's a great starting point for any new contributor that would like to work on BRL-CAD.  These tasks are all roughly the same complexity for an ''average'' person to complete (whatever that means) with very minimal familiarity expected.
+
This is a list of succinct tasks that are expected to take most people familiar with the prerequisites less than two hours to complete.  It's a great starting point for anyone interested in contributing to BRL-CAD.
  
Any requirements are listed along with any background information helpful for completing the task.
+
The tasks are all roughly the same complexity with '''''no prior BRL-CAD experience expected'''''.  A description is provided along with a list of references and files you'll probably need to edit.  Can we make it any easier?
  
Please do contact us (via [[IRC]] or [[Mailing_Lists|brlcad-devel mailing list]]) if you have any questions, corrections, comments, or ideas of your own that you'd like to suggest.  Get started by [[Compiling]]!
+
= Getting Started =
  
----
+
Contact us (via [[IRC]] or [[Mailing_Lists|brlcad-devel mailing list]]) if you have questions, comments, or ideas of your own you'd like to suggest.
  
= Template =
+
We've made an awesome virtual disk image that has everything you need preconfigured and ready to go:
----
 
This is the template to be used for all tasks:
 
  
== Template example title ==
+
# [https://sourceforge.net/projects/brlcad/files/BRL-CAD%20for%20Virtual%20Machines/ Download our BRL-CAD Virtual Machine (VM) disk image.]
 +
# [https://www.virtualbox.org/wiki/Downloads Install VirtualBox.]
 +
# Import and start the VM, log in (the password is "Brlcad!" without the quotes).
 +
# Run "svn up brlcad-svn-trunk" and get started!
  
Brief background information not specific to the task goes first.  It might help to write this paragraph second.  Keep it succinct.
+
=Pick a Task=
  
This task involves ... the rest goes hereRemember, less than two hours expected for average or random contributor to do the work after reading this descriptionThe resulting task should be directly measurable without subjective interpretation.  Tell them exactly what they need to do.  Be specific.
+
We break down all tasks into one of five categories. Don't be worried if the tasks all sound confusing to youJust pick one and start reading the references we've providedJoin IRC or our mailing list and ask questions.
  
References:
+
# Code (programming)
* optionally list any url's that provide relevant background information
+
# Documentation and Training (writing)
 +
# Outreach and Research (graphics)
 +
# Quality Assurance (testing)
 +
# User Interface (designing)
  
Code:
+
__TOC__
* list any files you know they will need to read/edit
 
  
 
----
 
----
  
= Code =
+
== Code ==
 
----
 
----
 
''Tasks related to writing or refactoring code''
 
''Tasks related to writing or refactoring code''
  
== Implement a primitive surface area function ==
+
See the When You're Done section above for details on submitting your changes.
  
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones.  Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid.  Wikipedia, Wolfram Mathworld, and various other math sites (and research papers) around the web include the equations for most of our basic primitives while others are a little more tricky to compute.
+
 
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Fix bounding box function for our polygonal mesh (BoT) primitive ===
  
This task involves writing a new callback function that takes an rt_db_internal object and calculates the surface area (units are mm^2)There are numerous examples in our code where we compute surface area for other primitivesThe primitives that do not already have a centroid callback are itemized in following.
+
BRL-CAD provides functions for its geometric primitives that define a bounding box - a box that completely encloses the volume described by the primitive.  Ideally, these boxes are as small as possible while still enclosing the primitiveCurrently the routine for BoTs is incorrectYou can use stl-g, obj-g, or any of our other *-g converters to import BoT geometry for testing.  
  
References:
+
This task involves studying the current code for the function rt_bot_bbox() and determining what is causing the current inaccuracies (the mged 'bb' command is a good way to visualize primitive bounding boxes). Make changes to produce a more optimal bounding box. Reimplement it from scratch if you like. The raytracing prep code in rt_bot_prep does prepare a better bounding box, so that is one place to check.
* http://en.wikipedia.org/wiki/Surface_area
 
* http://mathworld.wolfram.com/
 
* include/raytrace.h: See ft_surf_area callback defined in the rt_functab structure
 
  
 
Code:
 
Code:
* src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c
+
* src/librt/primitives/bot/bot.c
  
=== ... surface area function for elliptical hyperboloids (EHY) ===
+
|}
=== ... surface area function for right hyperbolic cylinders (RHC) ===
+
 
=== ... surface area function for hyperboloids of one sheet (HYP) ===
+
 
=== ... surface area function for polyhedron with 4 to 8 sides (ARB8) ===
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
=== ... surface area function for N-faced polysolid (ARBN) ===
+
|
=== ... surface area function for extruded bitmaps (EBM) ===
+
=== Close MGED when both windows are closed ===
=== ... surface area function for gridded volumes (VOL) ===
 
=== ... surface area function for super ellipsoids (SUPERELL) ===
 
=== ... surface area function for polygonal meshes (NMG) ===
 
=== ... surface area function for triangle meshes (BOT) ===
 
=== ... surface area function for NURBS objects (BREP) ===
 
  
== Implement a primitive volume function ==
+
BRL-CAD has an interactive geometry editor called MGED.  It's often the starting point for beginners and allows creation and manipulation of models using commands.  When ''mged'' is run, it creates 2 windows:  a text-console command window and an interactive graphics window.  When the user closes one of those windows, there is a bug.  Closing the graphics window closes the command window.
  
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones.  Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid.  Wikipedia, Wolfram Mathworld, and various other math sites (and research papers) around the web include the equations for most of our basic primitives while others are a little more difficult to compute.
+
This task involves fixing this behavior so that ONLY closing ''both'' windows terminates the process properly and that closing either window does not take the other along with it.
  
This task involves writing a new callback function that takes an rt_db_internal object and calculates the volume (units are mm^3). There are numerous examples in our code where we compute volume for other primitives.  The primitives that do not already have a volume callback are itemized in following.
+
Code:
 +
* src/mged/mged.c
 +
* src/tclscripts/mged/openw.tcl
  
References:
+
|}
* http://en.wikipedia.org/wiki/Volume
+
 
* http://mathworld.wolfram.com/
 
* include/raytrace.h: See ft_volume callback defined in rt_functab structure
 
  
Code:
 
* src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c
 
  
=== ... volume function for right hyperbolic cylinders (RHC) ===
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
=== ... volume function for elliptical hyperboloids (EHY) ===
+
|
=== ... volume function for hyperboloids of one sheet (HYP) ===
 
=== ... volume function for super ellipsoids (SUPERELL) ===
 
=== ... volume function for extruded bitmaps (EBM) ===
 
=== ... volume function for gridded volumes (VOL) ===
 
=== ... volume function for triangle meshes (BOT) ===
 
=== ... volume function for solid polygonal meshes (NMG) ===
 
=== ... volume function for extruded sketches (EXTRUDE) ===
 
  
== Implement a primitive centroid function ==
+
=== Implement a primitive centroid function ===
  
 
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones.  Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid.  Wikipedia, Wolfram Mathworld, and various other math sites (and research papers) around the web include the equations for most of our basic primitives while others are a little more tricky to compute.
 
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones.  Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid.  Wikipedia, Wolfram Mathworld, and various other math sites (and research papers) around the web include the equations for most of our basic primitives while others are a little more tricky to compute.
  
This task involves writing a new callback function that takes an rt_db_internal object and calculates its centroid (as a point_t 3D point).  There are numerous examples in our code where we compute centroids for other primtiives.  The primitives that do not already have a centroid callback are itemized in following.
+
This task involves writing a new callback function that takes an rt_db_internal object and calculates its centroid (as a point_t 3D point).  There are numerous examples in our code where we compute centroids for other primitives.  The primitives that do not already have a centroid callback are itemized in following.
  
 
References:
 
References:
Line 94: Line 83:
 
* src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c
 
* src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c
  
=== ... centroid function for elliptical hyperboloids (EHY) ===
+
|}
=== ... centroid function for right hyperbolic cylinders (RHC) ===
+
 
=== ... centroid function for hyperboloids of one sheet (HYP) ===
+
 
=== ... centroid function for polyhedron with 4 to 8 sides (ARB8) ===
+
 
=== ... centroid function for extruded bitmaps (EBM) ===
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
=== ... centroid function for gridded volumes (VOL) ===
+
|
=== ... centroid function for N-faced polysolids (ARBN) ===
 
=== ... centroid function for extruded sketches (EXTRUDE) ===
 
=== ... centroid function for super ellipsoids (SUPERELL) ===
 
=== ... centroid function for solid polygonal meshes (NMG) ===
 
  
== Move LIBBN comments from source to header files ==
+
=== Implement a primitive curvature function ===
  
BRL-CAD uses Doxygen source code comments to document the APIThe comments need to be moved from .c source code files to the corresponding .h API header file.  There are approximately 300 public API functions across 30 files in LIBBN.
+
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones each described by a collection of callback functions, for example rt_sph_bbox() returns the bounding box dimensions for a sphereWikipedia, Wolfram Mathworld, and various other math sites (and research papers) around the web include the equations for most of our basic primitives while others are a little more tricky to compute.
  
This task involves editing source code to move comments, cleaning up comment formatting, and verifying Doxygen output.
+
This task involves writing the callback function rt_xxx_curve() that computes the curvature at a given point on the surface of a primitive such as;
 +
* superell
 +
* cline
 +
* extrude
 +
* grip
 +
* metaball
 +
* hrt. 
 +
There are numerous examples in our code where we compute the curvature for other primitives like the ellipsoid, sphere, elliptical parabola, etc.
  
Time: <1 day
+
References:
 +
* http://en.wikipedia.org/wiki/Curvature
 +
* http://en.wikipedia.org/wiki/Radius_of_curvature_(mathematics)
 +
* http://mathworld.wolfram.com/
 +
* include/raytrace.h: See the data structure that holds the curvature of a surface at a point (from Line 296) as well as the prototype for ft_curve() callback function defined in the rt_functab structure ( Line 2078).
  
 
Code:
 
Code:
* include/bn.h
+
* src/librt/primitives/table.c
* src/libbn/*.c
+
* src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c
 +
 
 +
|}
 +
&nbsp;
 +
 
 +
 
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
  
== Convert BU_SETJUMP/BU_UNSETJUMP blocks into try/catch layout ==
+
=== Implement a primitive UV-mapping callback ===
  
BRL-CAD's basic utility library (LIBBU) provides a set of macros, BU_SETJUMP and BU_UNSETJUMP, that are used for exception handling.
+
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones.  Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid.  One of those functions describes a UV mapping of the object's surface, which is used for things like texture and bump mapping.  An example of this is rt_ell_uv() in the src/librt/primitives/ell/ell.c source file for an ellipsoid.  Several of our more complex primitive types (such as BoT, NMG, and BREP/NURBS) do not presently implement a UV-mapping function leading to unexpected runtime behavior.
  
This task involves restructuring the logic where those macros are used so that they are all consistently in a more familiar "try/catch" orderingMost are merely in "catch/try" order and need to be reversed, some are in an unstructured layoutThere are approximately 50 places that need to be updated.
+
This task involves implementing a UV-mapping callback for any of the primitives that do not already have a functional UV-callback definedNote that this is an advanced task that might take you more than a couple hours if you don't have solid coding skills, but it's ultimately just a few lines of codeSee other primitives that already implement a UV-mapping callback for reference.
  
Time: < 2 days
+
References:
 +
* http://en.wikipedia.org/wiki/UV_mapping
 +
* src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c, read the rt_*_uv() function
 +
 
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... UV-mapping for extruded sketches (EXTRUDE) ====
  
 
Code:
 
Code:
* include/bu.h
+
* src/librt/primitives/extrude/extrude.c
* src/**/*.c
+
* src/librt/primitives/table.c
 +
* include/rtgeom.h
  
== Move LIBRT comments from source to header files ==
+
|}
 +
&nbsp;
  
BRL-CAD uses Doxygen source code comments to document the API.  The comments need to be moved from .c source code files to the corresponding .h API header file.  There are approximately 1000 public API functions across 200 files in LIBRT.
+
|}
 +
&nbsp;
 +
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Implement a platform independent re-entrant sort function ===
  
This task involves editing source code to move comments, cleaning up comment formatting, and verifying Doxygen output.
+
The classic C library qsort() does not support a context parameter.  A work around is to store the context information in a static variable.  However, this solution is not thread save and may result in unpredictable behavior.
  
Time: <4 days
+
There are platform specific sort functions qsort_r() in incompatible versions for BSD and GNU and qsort_s() for MSVC.  Your task is to implement a bu_sort() function for BRL-CAD which is platform independent.
  
 
Code:
 
Code:
* include/raytrace.h
+
* src/libbu/sort.c
* include/nmg.h
 
* include/db.h
 
* include/db5.h
 
* src/librt/*.c
 
* src/librt/comb/*.c
 
* src/librt/binunif/*.c
 
* src/librt/primitives/**/*.c
 
  
== Fix 'analyze' command output formatting ==
+
The new sort function could look like this:
 +
void bu_sort(genptr_t array, size_t nummemb, size_t sizememb, int (*compare)(const_genptr_t, const_genptr_t, genptr_t), genptr_t context);
 +
|}
 +
&nbsp;
  
BRL-CAD has an interactive geometry editor called MGED.  MGED has several hundred commands including an "analyze" command that reports basic statistics such as bounding box size for a given geometry object.  Over time, the output format of the analyze command has become misaligned and disorganized with messy printing.
+
----
  
This task involves cleaning up the basic printf-style printing so that columns line up neatly and the ornamental ascii table lines are properly aligned.  The table lines should be rewritten to automatically expand as needed for the content being printed so it doesn't become a repeat maintenance burden in the future.
+
|}
 +
&nbsp;
 +
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Solve fonts related bug in new wiki theme ===
  
Time: <2 days
+
BRL-CAD has been working on a new incarnation of the website and has developed a new wiki theme and wordpress theme. Wiki theme uses a font called 'open-sans' from google fonts directory. It's linked via CSS but it does not get loaded (we still see default serif all over the place). So your task will be to debug the CSS code and get Open Sans loaded.
  
Code:
+
Links:
* src/libged/analyze.c
+
*http://beta.brlcad.org/wiki/Main_Page
  
== Camera 360: A script to capture images while rotating the view around a scene ==
+
&nbsp;
  
BRL-CAD allows the viewing angle for a scene to be set through a number of parameters. These are the azimuth, elevation, twist and also the amount of zoom for the scene. To render a scene a user first sets the view in MGED and then saves the view parameters in a BASH script. This script contains a call to the BRL-CAD ray tracing tool '''rt'''. The appropriate settings to its command line flags are written such that the images are rendered from the view set by the user in MGED.
+
----
  
The command for invoking rt may be called multiple times in a loop, each time carrying out a small change in the scene such as translating some geometry to achieve basic animation.
+
|}
 +
&nbsp;
 +
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Better placement of icons in wiki theme ===
  
This task involves developing a bash script that changes the parameters to rt in every loop iteration such that the view camera revolves around the origin of the scene at a particular distance from it , in the XY plane. The camera should change the view in small increments such that the images are captured in small angular increments. This would allow a video to be created with the effect of walking around a model while inspecting it from all sides.
+
BRL-CAD has been working on a new incarnation of the website and has developed a new wiki theme and wordpress theme. Wiki theme is responsive but has a small styling problem. On smaller screens icons near the search bar gets misplaced and unaligned. Your task would be to fix that. Task would include diving into sass file that corresponds to styling of this part of theme (given below) and adjusting spacing between icons to keep them aligned even at smaller screens.
  
Note: that an equivalent effect could also be achieved by keeping the view steady but revolving the model gradually by 360 degrees instead.
+
Links:
 +
*http://beta.brlcad.org/wiki/Main_Page
  
Time: ~ 3 days
+
&nbsp;
  
Code:
+
----
* src/**/*.c
+
|}
  
== Close MGED when both its windows are closed ==
+
== Documentation and Training ==
 +
----
 +
''Tasks related to creating/editing documents and helping others learn more about BRL-CAD''
  
BRL-CAD has an interactive geometry editor called MGED. It's often the starting point for beginners and allows creation and manipulation of models using commands. When MGED is invoked, then it creates 2 windows :
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
* A command window
+
|
* An OpenGL graphics window.
+
=== Add missing documentation (for any ONE command) ===
  
A user types command in the command window and views the results in the graphics window. However when the application is closed then it has a non-intuitive behavior in the sense that even if both the windows are manually closed, the MGED process is not terminated. Thus the proper way of closing it is through the exit command in the MGED command window.
+
BRL-CAD is an extensive system with more than 400 commands and more than a million pages of documentation, but there are approximately 120 commands that are entirely undocumented:
  
This task involves fixing this behavior such that closing ''both'' the windows terminates the process properly.
+
a-d archer asc2g asc2pix bot-bldxf bottest brep_cube brep_simple brickwall btclsh burst bw-a bw-d bwish c-d chan_add clutter contours d-a damdf dauto dauto2 d-bw dconv ddisp d-f dfft d-i dmod double-asc dpeak dsel dsp_add dstat d-u dwin euclid_format euclid_unformat fbgammamod f-d fence fhor f-i g-adrt g-euclid1 g-jack globe g-off i-a i-d i-f ihist imod istat jack-g kurt lowp molecule nmgmodel nmg-sgp off-g pipe pipetest pix2g pix3filter pixcount pixelswap pixembed pixfields pixfieldsep pixflip-fb pixpaste pix-spm pix-yuv plstat pyramid rawbot remapid rlesortmap rletovcr room rtcell rtexample rtfrac rtrad rtsil rtsrv script-tab sketch solshoot sphflake spltest spm-fb ssampview syn tea tea_nmg testfree texturescale torii ttcp tube txyz-pl u-a u-bw u-d u-f umod ustat vcrtorle vegitation wall wdb_example xbmtorle xyz-pl yuv-pix
  
Time: ~ 4 days
+
This task involves writing basic documentation for '''JUST ONE''' of those commands in the Docbook XML format.  The command documentation should provide a one-sentence description, a detailed paragraph description (200+ words), explanation of '''all''' available command-line options, and one or more examples on how to use the command.
  
 
Code:
 
Code:
* src/mged/mged.c
+
* doc/docbook/system/man1/en/Makefile.am
 +
* doc/docbook/system/man1/en/*.xml
 +
 
 +
|}
 +
 
 +
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Write an article "BRL-CAD for dummies" ===
 +
 
 +
Although BRL-CAD has extensive documentation, still it needs a short and simple document which is particularly built for dummies.
  
== Implement parallel support for Windows ==
+
This task involves writing a article named '''BRL-CAD for dummies'''. This article should start with the installation process, if there is any existing installation guide for dummies, provide a link to it. The main motive of this article to empower dummy to make his/her first model using BRL-CAD. One thing to be kept in mind while writing this article is that this article is mainly concentrated for dummies. So use simple language to an extent and if you need to mention some technical term, first explain that term.
  
BRL-CAD works pervasively on symmetric multiprocessing (SMP) systems, i.e. computers with multiple CPUs or cores. However, support for SMP is implemented for each distinct platform.  BRL-CAD runs on Windows, but presently only in a single-threaded mode.
+
The output of this task can be a pdf, html, doc, odt or any other document file that contains this article. Go through the link provided. Use screenshots and images to make it look attractive so that the reader is not bored.
  
This task involves implementing the hooks necessary to make BRL-CAD work in parallel on Windows.  This can be achieved with relatively minor source code modifications to two files.
+
Reference:
 +
* http://brlcad.org/wiki/Documentation
  
Time: <2 days
+
|}
  
Code:
+
&nbsp;
* src/libbu/parallel.c
 
* src/libbu/semaphore.c
 
  
== Decouple LIBDM from LIBGED ==
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Translate "Contributors Guide To BRL-CAD" To Any Language ===
  
BRL-CAD has a 3D display manager library (LIBDM) and a geometry editor command library (LIBGED).  For clean encapsulation and library management, it's desirable to keep library dependencies to a minimum.  LIBGED presently makes direct calls to LIBDM for a "screengrab" command. Properly fixed, it should be possible to remove the LIBDM linkage from LIBGED's build file and the command still work as expected.
+
People interested in improving BRL-CAD sometimes find themselves lost in a sea of information. In all, BRL-CAD has more than a million words of documentation across hundreds of manual pages, dozens of tutorials and examples, hundreds of wiki pages, dozens of technical papers, and other resources. There are literally thousands of features and this can sometimes pose problems.
  
This task involves breaking the dependency of LIBGED on LIBDM by making LIBGED not directly call any LIBDM functions.  To do this, LIBGED will likely need to introduce a callback mechanism in the "ged" struct so that the screengrab command can capture an image without directly calling a LIBDM function.
+
In 2013, a team of contributors got to California and worked on an entire book titled "Contributors Guide To BRL-CAD" in just a few days. This great resource needs to be translated to other languages to attract developers from other lingual backgrounds (who don't read English ) to contribute to BRL-CAD.
  
Time: <3 days
+
This task involves translating the chapters/sections of the "Contributors Guide To BRL-CAD" into a language of your choice such as Mandarin, French, Chinese, Spanish, German, Hindi, Arabic, Russian, etc. Chapters/Sections include
 
Code:
 
* include/ged.h
 
* include/dm.h
 
* src/libged/screengrab.h
 
* src/libged/CMakeLists.txt
 
  
== Separate out LIBNMG from LIBRT ==
+
* Feature Overview
 +
* Working with our Code
 +
* What code to work on
 +
* How to contribute
 +
* .... (Just to name a few )
  
BRL-CAD has an N-Manifold Geometry (NMG) library embedded within our ray tracing (RT) library.  The NMG source code is already isolated and separate but not cleanly and not into its own library.
+
The output of this task can be a pdf, html, doc, odt or any other document file that contains the translated article.Images in the original document (see link in Reference below) should not be changed ! only text should be.
  
This task involves moving the NMG source code into its own library directory and making the appropriate build system modifications so that it compiles the new library cleanly. There may be minor source code refactorings necessary to decouple the NMG code from LIBRT, but nothing major is expected.
+
Reference:
 +
* http://en.flossmanuals.net/_booki/contributors-guide-to-brl-cad/contributors-guide-to-brl-cad.pdf
  
Time: <3 days
+
|}
  
Code:
+
&nbsp;
* include/raytrace.h
 
* include/nmg.h
 
* src/librt
 
* src/librt/primitives/nmg
 
  
== implement runtime detection of SSE ==
 
  
BRL-CAD will optionally leverage SSE instructions for some operations but SSE-support is set at compile-time.  If you attempt to perform SSE instructions on non-SSE hardware, it'll basically halt the application with an illegal instruction exception. 
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
  
This task involves implementing a new libbu function that reports whether SSE support is available at runtime.  The most prevalent method for doing this is demonstrated by the Mesa folks where you set up an exception handler for SIGILL and attempt an SSE instruction.  That's obviously a non-solution for Windows platforms, but is better than nothing and more useful than a Windows-only solution.  Even better if you can handle both.
+
=== Write a "BRL-CAD Commands Quick Reference" document ===
  
Time: <2 days
+
There is already a command quick reference for BRL-CAD's MGED geometry editing tool, but there is not a similar document for BRL-CAD's 400+ command-line commands.
  
Code:
+
This task involves writing a quick reference document similar to [http://brlcad.org/w/images/5/52/MGED_Quick_Reference_Card.pdf the MGED quick reference] but for BRL-CAD commands.  The sheet should minimally include the following commands:
* include/bu.h
 
* src/libbu
 
  
== Integrate hi/lo geometry wireframe modifications==
+
mged, rt*, *-g, g-*, fb*, *fb, nirt, remrt, rtsrv, asc2g, g2asc, dbupgrade, pix*, *pix, *-*, brlman, benchmark
  
BRL-CAD presently draws wireframes of geometry with a fixed level of detail. A contributor implemented support for "high" and "low" detail wireframes but their changes were to a very old version that could not be simply applied to the current source code.
+
References:
 +
* http://brlcad.org/wiki/Documentation
 +
* http://brlcad.org/w/images/5/52/MGED_Quick_Reference_Card.pdf
 +
* [http://appletree.or.kr/quick_reference_cards/CVS-Subversion-Git/git-cheat-sheet-large.png git example]
 +
* [http://www.stdout.org/~winston/latex/latexsheet-0.png latex example]
 +
* [http://img.docstoccdn.com/thumb/orig/524314.png another example]
 +
* [http://www.inmensia.com/files/pictures/internal/CheatSheetDrupal4.7.png drupal example]
 +
* [http://www.phpmagicbook.com/wp-content/uploads/2010/06/php-reference-card.jpg php example]
  
This task involves identifying their source code changes (easy), isolating them (relatively easy), applying them to the current source code (maybe tricky, maybe not), documenting the new feature (trivial), and making sure everything works.
+
|}
 +
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
  
Time: <4 days
+
=== Doxygen cleanup ===
  
Code:
+
BRL-CAD uses Doxygen for most API documentation but the comment blocks are not optimally set up for Doxygen output.
* modified source tarball will be provided
 
* src/librt/primitives/**/*.c  (the *_tess() functions)
 
  
== Fix Bounding Box function for BoT primitive ==
+
This task involves cleaning up the Doxygen comments in the library so that useful reports and API documentation automatically generated (correctly, completely, and cleanly).  Verify/fix any Doxygen syntax.  Verify/fix groups so that functions are organized neatly and all contained within a group.  Provide patches that give clean (PDF) output from Doxygen.
  
BRL-CAD provides functions for its geometric primitives that define a bounding box - a box that completely encloses the volume described by the primitive. Ideally, these boxes are as small as possible while still enclosing the primitive. Currently the routine for BoTs is incorrect.
+
References:
 +
* http://www.jiggerjuice.net/software/doxygen.html
 +
* http://www.stack.nl/~dimitri/doxygen/starting.html
 +
* http://www.stack.nl/~dimitri/doxygen/
  
This task involves studying the current code for the function rt_bot_bbox and determining what is causing the current inaccuracies (the bb command is a good way to visualize primitive bounding boxes) and making changes to produce a more optimal bounding box. The raytracing prep code in rt_bot_prep does prepare a better bounding box, so that is one place to check.
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... doxygen cleanup for LIBBU ====
  
Time: <4 days
+
There are approximately 300 documented API function calls in LIBBU.
  
 
Code:
 
Code:
* src/librt/primitives/bot/bot.c  (the rt_bot_bbox function)
+
* include/bu.h
 +
* src/libbu
 +
* misc/Doxyfile
  
== Implement a primitive UV-mapping callback ==
+
|}
  
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones. Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid. One of those functions describes a UV mapping of the object's surface, which is used for things like texture and bump mapping. An example of this is rt_ell_uv() in¬†the src/librt/primitives/ell/ell.c source file for an ellipsoid.  Several of our more complex primitive types (such as BoT, NMG, and BREP/NURBS) do not presently implement a UV-mapping function leading to unexpected runtime behavior.
+
&nbsp;
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... doxygen cleanup for LIBWDB ====
 +
 
 +
There are approximately 100 documented API function calls in LIBWDB.  
 +
 
 +
Code:
 +
* include/wdb.h
 +
* include/raytrace.h
 +
* src/libwdb
 +
* misc/Doxyfile
  
This task involves implementing a UV-mapping callback for any of the primitives that do not already have a functional UV-callback defined.
+
|}
 +
&nbsp;
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... doxygen cleanup for LIBRT ====
  
Time: <3 days
+
There are approximately 1000 documented API function calls in LIBRT.
  
 
Code:
 
Code:
* src/librt/primitives/*/*.c
+
* include/raytrace.h
* src/librt/primitives/table.c
+
* src/librt
* include/rtgeom.h
+
* src/librt/primitives
 +
* src/librt/comb
 +
* src/librt/binunif
 +
* misc/Doxyfile
 +
|}
 +
|}
 +
 
 +
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Write up Wiki page tutorial on our Volumetric Primitive ===
 +
 
 +
BRL-CAD provides a couple dozen distinct primitives. Each primitive is defined by a set of parameters.  Several of the more complex primitives have a wiki page describing them in more detail with an example on how to create them.
 +
 
 +
This task involves writing up a page on the VOL primitive. Figure out how to use it (see the "in" command), create an example input data set, and write up a wiki page on exactly what steps are needed similar to our other wiki pages:
  
 
References:
 
References:
* http://en.wikipedia.org/wiki/UV_mapping
+
* http://brlcad.org/wiki/DSP
 +
* http://brlcad.org/wiki/Sketch
 +
* http://brlcad.org/wiki/EBM  <-- particularly useful as the data is similar for VOL
 +
 
 +
Show how to create a VOL with at least two layers/slices.  Include images like the other examples.  Put the write-up at http://brlcad.org/wiki/VOL
 +
 
 +
|}
  
----
+
&nbsp;
=Documentation=
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
----
+
|
''Tasks related to creating/editing documents''
+
=== Write a wiki tutorial on how to create a polygonal mesh (NMG) manually ===
  
== Add missing documentation (for JUST ONE command) ==
+
BRL-CAD provides a couple dozen distinct primitives.  Each primitive is defined by a set of parameters.  Several of the more complex primitives have a wiki page describing them in more detail with an example on how to create them.
  
BRL-CAD is an extensive system with more than 400 commands and more than a million pages of documentation, but there are approximately 120 commands that are entirely undocumented:
+
This task involves writing up a page on the NMG polygonal mesh primitive.  Figure out how to use it (not a simple task, will require some trial and error), create an example input, and write up a wiki page on exactly what steps are needed similar to our other wiki pages:
  
a-d archer asc2g asc2pix bot-bldxf bottest brep_cube brep_simple brickwall btclsh burst bw-a bw-d bwish c-d chan_add clutter contours d-a damdf dauto dauto2 d-bw dconv ddisp d-f dfft d-i dmod double-asc dpeak dsel dsp_add dstat d-u dwin euclid_format euclid_unformat fbgammamod f-d fence fhor f-i g-adrt g-euclid1 g-jack globe g-off i-a i-d i-f ihist imod istat jack-g kurt lowp molecule nmgmodel nmg-sgp off-g pipe pipetest pix2g pix3filter pixcount pixelswap pixembed pixfields pixfieldsep pixflip-fb pixpaste pix-spm pix-yuv plstat pyramid rawbot remapid rlesortmap rletovcr room rtcell rtexample rtfrac rtrad rtsil rtsrv script-tab sketch solshoot sphflake spltest spm-fb ssampview syn tea tea_nmg testfree texturescale torii ttcp tube txyz-pl u-a u-bw u-d u-f umod ustat vcrtorle vegitation wall wdb_example xbmtorle xyz-pl yuv-pix
+
References:
 +
* http://brlcad.org/wiki/DSP
 +
* http://brlcad.org/wiki/EBM
 +
* http://brlcad.org/wiki/Sketch <-- particularly useful as neither NMG nor sketch are meant to be created manually
  
This task involves writing a failed document for '''JUST ONE''' of those commands in the Docbook format.  The command documentation should provide a one-sentence description, a detailed paragraph description, explanation of all available command-line options, and one or more examples on how to use the command.  
+
Note the "facetize" command in mged will convert an existing object into NMG format.  The get/put commands should help from there like the sketch tutorial.
  
Time: < 2 days
+
Show how to create an NMG cube or wedge or similar simple shape.  Include images like the other examples.  Put the write-up at http://brlcad.org/wiki/NMG
  
Code:
+
|}
* doc/docbook/system/man1/en/Makefile.am
 
* doc/docbook/system/man1/en/*.xml
 
  
== Write "MGED Interface" reference document==
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Fix Image Formatting in BRL-CAD's DocBook Documentation (any ONE large document or 4 smaller documents) ===
  
BRL-CAD's primary geometry editor is called MGEDMGED's documentation is extensive but incomplete without a concise 1 or 2 page document that details MGED's interface.  
+
The majority of BRL-CAD's documentation is defined as DocBook files, from which other formats (HTML, PDF, man page, etc.) can be generatedPDF files present a particular challenge, and have some very specific requirements to achieve "good" formatting.
  
This task involves writing an interface reference document that gives a brief descriptive overview of the key bindings, mouse bindings, and primary GUI elements. The [http://brlcad.org/w/images/8/8c/Shift_Grips_Quick_Reference_Guide.pdf shift grips reference] should be incorporated, albeit much more concisely and organized.
+
BRL-CAD's DocBook files need to uniformly use a style of image inclusion that is aware of what "role" the image is supposed to serve.   A "basic" image inclusion example looks like this:
  
Time: <2 days
+
  <mediaobject>
 +
    <imageobject>
 +
      <imagedata align="center" fileref="../../lessons/en/images/img.png" format="PNG"/>
 +
    </imageobject>
 +
    <nowiki><caption></nowiki>
 +
      <para>
 +
        Caption goes here.
 +
      </para>
 +
    </caption>
 +
  </mediaobject>
  
References:
+
This task involves switching image inclusions that use the above style to something like the following:
* http://brlcad.org/wiki/Documentation
 
* http://brlcad.org/w/images/c/cf/Introduction_to_MGED.pdf
 
* http://brlcad.org/w/images/8/8c/Shift_Grips_Quick_Reference_Guide.pdf
 
* http://www.audioease.com/Pages/Altiverb/features/2small.jpg
 
  
== Convert src/conv man pages to valid Docbook  ==
+
  <mediaobject>
 +
    <imageobject role="html">
 +
      <imagedata align="center" fileref="../../books/en/images/img.png" format="PNG"/>
 +
    </imageobject>
 +
    <imageobject role="fo">
 +
      <imagedata align="center" fileref="../../books/en/images/img.png" format="PNG"/>
 +
    </imageobject>
 +
    <nowiki><caption></nowiki>
 +
      <para>
 +
        Caption goes here.
 +
      </para>
 +
    </caption>
 +
</mediaobject>
 +
 +
The "role" flag to imageobject provides the opportunity to specify different image formatting options when the output is HTML (role="html") or PDF (role="fo").
  
BRL-CAD is in the process of converting its documentation into Docbook 4.5 format, in order to enable automatic generation of output in different formats (html, pdf, man) from a single source.  This conversion includes existing UNIX man pages.
+
The captions should be preserved as above on mediaobjects that have them, but mediaobjects without a caption should also be converted and there is no need to add a caption in such cases.
  
This task involves using the doclifter tool to perform a rough conversion to Docbook of all man pages in the src/conv subdirectory of the BRL-CAD source tree (about 40 files), then performing whatever manual corrections are needed to the autogenerated xml files to make them valid Docbook (some conversions have already been done and can serve as guides)The simplest way to confirm the files are successfully converted is to incorporate them into BRL-CAD's build logic for Docbook man pages and view the output using brlman and an html viewer.  It is recommended to use the Emacs editor with the nxml mode in order to more easily identify and fix errors, but this is not a requirement.
+
Any patch that makes changes to the DocBook sources should result in a successful "make doc" build testThis won't generate PDF documents, but it will validate the XML files and produce HTML - remember that introducing breakage means the patch won't be accepted.
  
Time: <4 days
+
Remember, the tasks are simply to do the above conversion for all images in the file or files, not to introduce PDF specific formatting.  Formatting fixes will be needed, but they are very much "case by case" and will take both additional time and a working Apache FOP installation, as well as knowledge of how to enable PDF generation.  If all image inclusions have been converted successfully and a student is interested in actually fixing the formatting, please discuss it with us on IRC or the mailing list.
  
 
References:
 
References:
* Current Docbook man pages: http://brlcad.svn.sourceforge.net/viewvc/brlcad/brlcad/trunk/doc/docbook/system/
+
* doc/docbook/books/en/BRL-CAD_Tutorial_Series-VolumeIII.xml
* Docbook documentation: http://www.docbook.org/tdg/en/html/docbook.html
 
* Doclifter conversion tool: http://www.catb.org/~esr/doclifter/
 
* Emacs editor: http://www.gnu.org/software/emacs/emacs.html
 
* nxml Emacs mode: http://www.thaiopensource.com/nxml-mode/
 
  
== Write a "BRL-CAD Commands Quick Reference" document ==
+
Code:
 +
* doc/docbook
  
There is already a command quick reference for BRL-CAD's MGED geometry editing tool, but there is not a similar document for BRL-CAD's 400+ command-line commands.
+
|}
  
This task involves writing a quick reference document similar to [http://brlcad.org/w/images/5/52/MGED_Quick_Reference_Card.pdf the MGED quick reference] but for BRL-CAD commands.
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Make a step by step tutorial for creating BRL-CAD model ===
  
Time: <3 days
+
BRL-CAD is said to have an expert friendly User Interface so new users mostly have a tough time getting around it's UI and making models. So anything link Django poll app tutorial https://docs.djangoproject.com/en/dev/intro/tutorial01/ would be very helpful.
  
References:
 
* http://brlcad.org/wiki/Documentation
 
* http://brlcad.org/w/images/5/52/MGED_Quick_Reference_Card.pdf
 
  
== Write a "Technical Overview of BRL-CAD" document ==
+
|}
  
This task involves describing everything in BRL-CAD succinctly yet comprehensively.  Survey of all the major features, methodologies, and tools implemented in BRL-CAD with coverage on code maturity, library encapsulation, and tool aggregation.  The document should be less than 10 pages, possibly only 1 or 2 pages, but cover multiple layers of information concisely.
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Find 5 bugs in OGV ===
  
Time: <4 days
+
Online Geometry Viewer is a web based application with which you can see 3D .g models in browser without the use of any plugins. Your task will be to deploy OGV locally and find 5 bugs or errors in it.
  
References:
+
Links:
* http://brlcad.org/d/about
+
https://github.com/BRL-CAD/OGV-meteor/
* http://brlcad.org/wiki/Overview
 
  
== Add missing documentation (for ALL missing) ==
+
|}
  
BRL-CAD is an extensive system with more than 400 commands and more than a million pages of documentation, but there are approximately 120 commands that are entirely undocumented:
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
  
a-d archer asc2g asc2pix bot-bldxf bottest brep_cube brep_simple brickwall btclsh burst bw-a bw-d bwish c-d chan_add clutter contours d-a damdf dauto dauto2 d-bw dconv ddisp d-f dfft d-i dmod double-asc dpeak dsel dsp_add dstat d-u dwin euclid_format euclid_unformat fbgammamod f-d fence fhor f-i g-adrt g-euclid1 g-jack globe g-off i-a i-d i-f ihist imod istat jack-g kurt lowp molecule nmgmodel nmg-sgp off-g pipe pipetest pix2g pix3filter pixcount pixelswap pixembed pixfields pixfieldsep pixflip-fb pixpaste pix-spm pix-yuv plstat pyramid rawbot remapid rlesortmap rletovcr room rtcell rtexample rtfrac rtrad rtsil rtsrv script-tab sketch solshoot sphflake spltest spm-fb ssampview syn tea tea_nmg testfree texturescale torii ttcp tube txyz-pl u-a u-bw u-d u-f umod ustat vcrtorle vegitation wall wdb_example xbmtorle xyz-pl yuv-pix
+
=== Find 5 coding guidelines violations in OGV ===
  
This task involves writing a (very) simple stub document holder for each of those commands in the Docbook format. The commands only need to provide a one or two sentence summary of their purpose (which is usually already written in their source files) with a basic usage statement.
+
Online Geometry Viewer is a web based application with which you can see 3D .g models in browser without the use of any plugins. Your task will be to deploy OGV locally, look into code and see if any coding guidelines are violated.  
  
Time: < 4 days
+
Links:
 +
https://github.com/BRL-CAD/OGV-meteor/
  
Code:
+
|}
* doc/docbook/system/man1/en/Makefile.am
 
* doc/docbook/system/man1/en/*.xml
 
  
 +
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 
----
 
----
  
= Outreach =
+
==Outreach and Research ==
 
----
 
----
''Tasks related to community management and outreach/marketing''
+
''Tasks related to community management, outreach/marketing, studying problems, and recommending solutions''
  
== Write solicitation for new website designer ==
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Profile NURBS prep performance ===
  
The BRL-CAD website is in need of a design overhaul.
+
BRL-CAD implements support for rendering of NURBS representation geometry.  If you import a solid 3DM or STEP format model into BRL-CAD, it will import as BREP/NURBS geometry.  Opening that geometry in BRL-CAD's MGED editor will tell you what objects are available and our 'rt' tool will raytrace it.  When geometry is ray traced, it first goes through a "prep" phase and then it starts shooting rays.  Our prep phase is entirely unoptimized so we'd like to know where all the time is presently being spent during prep..
  
This task involves writing up a brief article soliciting new contributor(s) to work on designing a new websiteThe article needs to be detailed and specific to our particular website requirements (Drupal+Mediawiki+CSS) to ensure the contributor can design the appropriate stylesheet(s), updated graphics, and new layout.
+
This task involves importing some NURBS geometry into BRL-CAD and ray tracing that geometry with a profiler watching our prep performanceAny profiler will do, including gprof, but a performance monitor like oprofile or the Mac "Instruments" application (or Shark) are preferred.
  
Time: < 2days
+
Learning how to use a profiler is beyond the scope of this task, so it make take you considerably longer to provide us with useful information if you've never run a profiler before.
  
References:
+
To capture prep performance, you will need to import some fairly complex geometry.  You should be able to search google with "filetype:3dm" or "filetype:step" or find something on grabcad.com to import
* http://brlcad.org
 
  
== Model new BRL-CAD Logo using BRL-CAD ==
+
Running "tops" within mged will tell you what geometry is available for rendering.
  
The winner of the recent BRL-CAD Logo contest is a clean depiction of two interlocked components. Modeling the new Logo in BRL-CAD without using NURBS would require some careful arrangement, but would provide an attractive three dimensional rendering.
+
Running "rt -o file.png -s32" on the system command line (not inside mged) should minimize the ray overhead or you can specifically isolate the prep phase we care about.  Prep is the time between when rt is run where it opens a window until the first pixels are fired and pixels start filling in.
 +
|}
  
The output of this task would be a .asc file of BRL-CAD geometry (converted via g2asc) for inclusion in the db/ example directory.  Optimally, the two segments would overlap at the join, but this is your opportunity as an artist and 3D magician to shine with your interpretation.
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Continue investigating GMP integration ===
  
Time: < 2 days
+
BRL-CAD uses a fastf_t typedef for most all math operations that is usually a "double" floating point type. We would like to provide the option for resorting to exact arithmetic if possible by merely redefining fastf_t to a C++ type sufficiently overloaded to behave the same. You should be proficient with C++ operator overloading to take this work on.  This task is a continuation of a prior GCI task (read it in full!):
  
References:
+
http://www.google-melange.com/gci/task/view/google/gci2012/7946218
* http://brlcad.org/images/angelov_256.png
 
* http://brlcad.org/d/node/92
 
* Introduction to MGED at http://brlcad.org/wiki/Documentation
 
  
== Write BRL-CAD News article on .deb/.rpm builds ==
+
This task involves testing compilation with a C++ class with overloaded operators such that vmath macro calls still work as well as a sampling of LIBBN API function calls without major changes to the original code. A perfect example case study would be creating the class then testing whether bn_dist_pt3_pt3() and bn_mat_determinant() compute correctly for values that cannot be exactly represented with floating point arithmetic.
  
BRL-CAD has a new maintainer, Jordi Sayol, for managing .deb and .rpm buildsInterview the developer, obtain details on how the releases are produced, what platforms are supported, etc, and write up an article for our Community Publication Portal (CPP)
+
Building on the previous GCI task work, take it to the next step.  Try setting a vector to 1/3, 1/3, 1/3 and 0.1, 0.1, 0.1 and get proper values to print. Change the V3ARGS() macro if neededIf that all works, try to get bn_dist_pt3_pt3() to work.  Report and discuss your progress.
  
The output of this task is an article added to our CPP wiki page in a final production-quality review state.
+
|}
  
Time: < 1 day
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Design a T-Shirt for BRL-CAD ===
  
References:
+
This task involves designing a T-Shirt for BRL-CAD. Use your designing skills to design a T-Shirt for BRL-CAD. You can use the current BRL-CAD logo, or you may tweak it. Be creative while designing this T-Shirt. It would be good if the design has some special meaning.
* http://brlcad.org/wiki/Community_Publication_Portal
 
  
== Write a BRL-CAD model showcase article ==
+
Logo References
 +
* http://brlcad.org/images/angelov_256.png
 +
* http://brlcad.org/d/node/92
  
BRL-CAD has several geometry models developed by community members that showcase the power and applicability of BRL-CAD to various domains.  For this task, you'd be expected to interview one or more individuals to obtain information and pictures about their project, write up a descriptive overview of their model, the goals of the project, and any interesting ancillary information that may be relevant.  There are presently several candidate topics listed in our Community Publication Portal (CPP).
+
|}
  
The output of this task is an article added to our CPP wiki page in a final production-quality review state.
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Design a coffee mug for BRL-CAD ===
  
Time: < 2 days
+
This task involves designing a coffee mug for BRL-CAD. Make it look good, so that one can use it while working on BRL-CAD. Look over some great coffee mug designs before starting to work on this. It would be great if the design on coffee mug has some special meaning.
  
References:
+
Logo References
* http://brlcad.org/wiki/Community_Publication_Portal
+
* http://brlcad.org/images/angelov_256.png
 +
* http://brlcad.org/d/node/92
  
== Design a "Commercial CAD Comparison" diagram ==
+
|}
  
New users frequently ask how BRL-CAD compares to other major commercial CAD systems such as CATIA, Unigraphics/NX, Pro/ENGINEER, Solidworks, and AutoCAD.  BRL-CAD has many of the same features and it would be very useful to visualize the feature overlap graphically with a diagram.
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Design BRL-CAD sticker ===
  
This task involves identifying core significant features of relevance and describing BRL-CAD along with the various major CAD vendors. The diagram should fit on one page.
+
This task involves designing a BRL-CAD sticker. The design should be simple and sleek. The concept of sticker should be clear and also it should be creatively presented. Get inspired from some sticker designs but choose your own imagination while designing the sticker. There is no bound for shape of sticker, it can be rectangular, circular or even irregular. The only thing that matters is that it should look good.
  
Time: <2 days
+
Logo References
 +
* http://brlcad.org/images/angelov_256.png
 +
* http://brlcad.org/d/node/92
  
References:
+
|}
* http://brlcad.org/Industry_Diagram.png
 
* Example feature comparisons (although not a diagram): http://en.wikipedia.org/wiki/Comparison_of_3D_computer_graphics_software
 
* Additional feature comparisons (also not a diagram): http://en.wikipedia.org/wiki/Comparison_of_CAD_editors_for_CAE
 
  
----
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Design BRL-CAD phone/tablet back cover ===
  
= Quality Assurance =
+
This task involves designing a BRL-CAD phone/tablet cover.
----
+
While submitting your design, provide the sample phone cover, tablet cover with the design and rendered png or jpg image of the sticker design. Try to have a special meaning of design, and the concept should be creatively illustrated.
''Tasks related to testing and ensuring code is of high quality''
 
  
== Develop an N-Manifold Geometry (NMG) testing framework==
+
Logo References
 +
* http://brlcad.org/images/angelov_256.png
 +
* http://brlcad.org/d/node/92
  
BRL-CAD implements polygonal facetted geometry as "NMG" geometry, which is then used for converting from an implicit constructive solid geometry (CSG) representation to a mesh format.  This is a huge portion of BRL-CAD's core libraries that is used by dozens of tools and commands so there is a need for improved robustness.
+
|}
  
This task involves custom scripting or using a testing framework (such as googletest) that attempts to convert all of BRL-CAD's provided sample geometry into NMG format.  There are more than 500 functions in the NMG code, so this task only exercises the NMG code indirectly through one of BRL-CAD's numerous geometry exporters such as g-nmg or g-dxf.  The testing should report which objects do not successfully convert and percentage conversion success.
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Design a wallpaper set for BRL-CAD ===
  
Time: <2 days
+
This task involves designing a set of wallpapers for BRL-CAD. The central idea of each wallpaper should represent any feature of BRL-CAD. Try to design a minimum of 5 wallpapers but if you have more than 5 designs than you are welcomed.
 +
 +
Try to different resolutions of each wallpaper.
  
Files:
+
Check the following wallpapers for inspiration.
* db/*.g
+
* http://www.smashingmagazine.com/tag/wallpapers/
* src/conv/g-nmg
 
  
References:
+
Logo References
* http://en.wikipedia.org/wiki/Topological_manifold
+
* http://brlcad.org/images/angelov_256.png
* http://en.wikipedia.org/wiki/Constructive_solid_geometry
+
* http://brlcad.org/d/node/92
* http://code.google.com/p/googletest/
 
  
== Create comprehensive utility library (LIBBU) API unit tests ==
+
|}
  
There are more than 300 library functions in our core LIBBU library.  As a core library used by nearly every one of BRL-CAD's tools, testing those functions for correct behavior is important.
 
  
This task involves implementing a testing framework for LIBBU that exercises every single one of the public API C function calls and reports whether tests pass successfully or not.
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create Iron Man Arc Reactor Model in BRL-CAD ===
  
Code:
+
This task involves creating Arc Reactor as seen in hollywood movie Iron-Man. You will have to create two versions of the Arc Reactor one glowing and another non glowing.
* include/bu.h
+
* src/libbu
+
Check this model for inspiration
 +
* http://grabcad.com/library/iron-man-arc-reactor-request
  
References:
 
* http://code.google.com/p/googletest/
 
  
Time: <3 days
+
|}
  
== Create comprehensive numerics library (LIBBN) API unit tests ==
 
  
There are more than 300 library functions in our core LIBBN library.  As a core library used by nearly every one of BRL-CAD's tools, testing those functions for correct behavior is important.
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Tweak BRL-CAD logo to wish New Year ===
  
This task involves implementing a testing framework for LIBBN that exercises every single one of the public API C function calls and reports whether tests pass successfully or not.
+
You might have heard and praised those google doodles we occasionally see on google.com on special days. This task is all about tweaking BRL-CAD logo to wish New Year. You may have a look at google doodles but don't entirely copy their style. I am sure your creative mind will get something much better.
 +
Make sure this tweak should be tweaked version of current logo and not entirely new logo.
  
Time: <3 days
+
Tip: Search for some global events occurring in 2015 and design accordingly. Also keep the letters 2,0,1,5 in mind while designing. ;)
  
Code:
+
Also output of this task shall be the png file of your work and the raw file but don't upload the raw file(.psd, .xcf or some other) for review of this task. We will ask for it later, when the design is finalized.
* include/bn.h
 
* include/plot3.h
 
* include/vmath.h
 
* src/libbn
 
  
References:
+
Gallery of all google doodles
* http://code.google.com/p/googletest/
+
* http://www.google.com/doodles
  
== Create a comprehensive unit test for bn_dist_pt3_pt3() ==
 
  
There are more than 300 library functions in our LIBBN numerics library.  Creating a comprehensive unit test involves exhaustively exploring all possible inputs to the function, testing them for proper behavior, and characterizing the output in a PASS/FAIL fashion.
+
|}
  
Unlike the other testing framework tasks, the goal of this task is comprehensiveness.  The task must cover all possible inputs including NULL, -inf, +inf, NaN, real numbers, and other values in most if not all possible combinations.
 
  
Time: <2 days
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Tweak BRL-CAD logo to wish Merry Christmas ===
  
Code:
+
You might have heard and praised those google doodles we occasionally see on google.com on special days. This task is all about tweaking BRL-CAD logo to wish Christmas. You may have a look at google doodles but don't entirely copy their style. I am sure your creative mind will get something much better.
* include/bn.h
+
Make sure the output of this task should be tweaked version of current logo and not entirely new logo.
* src/libbn
 
  
References:
+
Also output of this task shall be the png file of your work and the raw file but don't upload the raw file(.psd, .xcf or some other) for review of this task. We will ask for it later, when the design is finalized.
* http://code.google.com/p/googletest/
 
  
== Find, reproduce, confirm, and report any bug in Archer ==
+
Gallery of all google doodles
 +
* http://www.google.com/doodles
  
Archer is our new modeling interface and a soon-to-be replacement for our long-standing MGED geometry editor.  It undoubtedly has bugs.  It's your job to find them, but do so in a manner that is so obvious that one of the other devs will be able to instantly reproduce the bug given your instructions.  Crashing bugs are best, but may require learning how to use the tool with minimal documentation.
 
  
This task involves filing a bug report with verifiable and reproducible steps that clearly demonstrate the bug.  It can't be a bug already reported or otherwise documented.
+
|}
  
References:
+
----
* archer
 
* Introduction to MGED at http://brlcad.org/wiki/Documentation (many of the mged commands are available in some fashion within archer)
 
* BUGS file in any source/binary distribution
 
* http://sourceforge.net/tracker/?atid=640802&group_id=105292&func=browse
 
  
 +
== Quality Assurance ==
 
----
 
----
 +
''Tasks related to testing and ensuring code is of high quality''
 +
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Fix single-precision floating point crash ===
 +
 +
By default, all of BRL-CAD compiles using double-precision floating point arithmetic.  We provide a simple typedef, however, that converts almost the entire system over to single-precision floating point.  This compilation mode was recently cleaned up and tested, but a bug was found.  The problem is reproduced very simply by compiling in single precision mode and running our "rt" ray tracer tool.
  
= Research =
+
To compile in single precision, edit the include/bn.h header file and change the fastf_t typedef from double to float.  To reproduce the bug, compile BRL-CAD and write this out to a text file named star.view:
----
+
 
''Tasks related to studying a problem and recommending solutions''
+
viewsize 2.500000000e+05;
 +
eye_pt 2.102677960e+05 8.455500000e+04 2.934714650e+04;
 +
viewrot -6.733560560e-01 6.130643360e-01 4.132114880e-01 0.000000000e+00
 +
        5.539599410e-01 4.823888300e-02 8.311441420e-01 0.000000000e+00
 +
        4.896120540e-01 7.885590550e-01 -3.720948210e-01 0.000000000e+00
 +
        0.000000000e+00 0.000000000e+00 0.000000000e+00 1.000000000e+00 ;
 +
start 0;
 +
end;
  
== Investigate performance of setting thread affinity ==
+
Then run rt feeding it that view script as input.  This is an example how to run within the gdb debugger:
 +
gdb path/to/bin/rt
 +
...
 +
(gdb) run -F/dev/X -M .cmake/share/db/star.g all < star.view
  
BRL-CAD's raytrace library (LIBRT) is pervasively multithreaded using routines defined in our basic utility library (LIBBU) for detecting an using multiple CPUs/cores/threads.
+
At this point, rt should crash due to an infinite recursion.  A backtrace in the debugger will show lots and lots of calls to rt_shootray() and light_hit().
  
This task involves making minor modifications to the LIBBU parallel interface using sched_setaffinity and/or pthread_attr_setaffinity_np (or similar affinity mechanism depending on the platform) and then evaluating the performance impact using our BRL-CAD Benchmark suite ('benchmark' command).
+
This task involves investigating and preventing the crash.  Provide a patch that fixes the bug.
  
Time: <2 days
+
References:
 +
* man gdb
 +
* brlman rt
  
 
Code:
 
Code:
* src/libbu/parallel.c
+
* src/librt/shoot.c
* src/libbu/semaphore.c
+
* src/liboptical/sh_light.c
 +
 
 +
|}
  
== Determine why solids.sh fails on 64-bit ==
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Fix closedb ===
  
BRL-CAD has a regression test script called solids.sh that creates a bunch of primitives, renders an image of those primitives, and then compares that image to a reference imageOn (most?) 64-bit platforms, the test is off by several RGB values for exactly 3 pixels.
+
BRL-CAD geometry editor application (mged) has several hundred commands including two very simple commands for opening and closing a geometry database file. While the user rarely ever needs to close the file, as all changes are always immediately saved, it can be of use to scripting applicationsHowever, at some point in the recent past, the ''closedb'' command was horked.  It's undoubtedly something very simple but we haven't bothered to look due to other priorities.  You can fix it. If you run these simple steps within graphical mged, you should see how commands stop working after calling closedb:
  
This task involves figuring out why, exactly, this is occurring. It may be helpful to compare intermediate computation results from a 32-bit environment to see where the computations diverge, however slightly.  Ultimately, the goal is to identify the cause and a recommended course of action to fix the divergence problem.
+
  mged> opendb test.g y
 +
  mged> make sph sph
 +
  mged> l sph
 +
  mged> closedb
 +
  mged> make sph sph
 +
  mged> opendb test.g
 +
  mged> l sph
 +
  mged> exit
  
Time: <2 days
+
Provide a patch that fixes the bug or tell us which SVN revision introduced the bug.  Make sure you can reproduce the bug before claiming this task, which presumes you know how to download/install BRL-CAD from a source distribution.
  
 
Code:
 
Code:
* regress/solids.sh
+
* src/mged/mged.c
  
== Investigate permuted vertex lists from g-iges + iges-g ==
+
|}
  
BRL-CAD has a geometry exporter and importer for the International Graphics Exchange Standard (IGES) file format.  If you run our g-iges exporter on some geometry, then run iges-g on that same geometry to import it back to BRL-CAD format, the geometry will have permuted vertex lists.  Particularly for geometry already in polygonal format, such as our NMG or BoT geometry, this conversion should result in identical geometry but presently does not.
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create a utility library (LIBBU) API unit test ===
  
This task involves investigating why this occurs, reporting (in detail) why it occurs, and if obvious, making a recommendation on how to fix the problem.
+
There are more than 300 library functions in our core LIBBU library.  As a core library used by nearly every one of BRL-CAD's tools, testing those functions for correct behavior is important.
  
Time: <4 days
+
This task involves implementing new unit tests for any of LIBBU's source files that do not already have a unit test defined.  The test should run all of the public functions and be hooked into our build system.  We have lots of existing unit tests to follow as examples.
 +
 
 +
References:
 +
* include/bu.h
 +
* src/libbu/*.c
 +
* src/libbu/tests/*.c
  
 
Code:
 
Code:
* src/conv/iges
+
* src/libbu/tests/[TEST].c
 +
* src/libbu/tests/CMakeLists.txt
 +
 
  
== Investigate GMP integration ==
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... unit test for LIBBU bomb.c ====
 +
|}
 +
|}
  
BRL-CAD uses a fastf_t typedef for most all math operations that is usually a "double" floating point type.  We would like to provide the option for resorting to exact arithmetic if possible by merely redefining fastf_t to a C++ type sufficiently overloaded to behave the same.
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
  
This task would involve implementing a C++ class with overloaded operators such that vmath macro calls still work as well as a sampling of LIBBN API function calls without major changes to the original code.  A perfect example case study would be creating the class then testing whether bn_dist_pt3_pt3() and bn_mat_determinant() compute correctly for values that cannot be exactly represented with floating point arithmetic.
+
=== Create Numerics library (LIBBN) API unit tests ===
  
Time: <3 days
+
There are more than 300 library functions in our core LIBBN library.  As a core library used by nearly every one of BRL-CAD's tools, testing those functions for correct behavior is important.
  
Code:
+
This task involves implementing new unit tests for any of LIBBN's source files that do not already have a unit test defined. The test should run all of the public functions and be hooked into our build system.  We have lots of existing unit tests to follow as examples.
* include/vmath.h
 
* include/bn.h
 
  
 
References:
 
References:
* http://gmplib.org/
+
* include/bn.h
 +
* include/plot3.h
 +
* include/vmath.h
 +
* src/libbn/*.c
 +
* src/libbn/tests/*.c <-- check this directory for examples
 +
* src/libbu/tests/*.c <-- Note: Also check this too for more examples.
  
== Investigate the status of our command spreadsheet ==
+
Code:
 +
* src/libbn/tests/[TEST].c
 +
* src/libbn/tests/CMakeLists.txt
  
We have a spreadsheet filled with information about all of BRL-CAD's 400+ commands including details about what command line options, inputs, and outputs are supported.  The spreadsheet is not complete, however, and hasn't been reviewed in a couple years.
+
<b> Note </b>
 +
A valid task will constitute writing a basic test for each function in the following libbn/ files.
  
This task involves comprehensively going over the 400+ rows of the spreadsheet to systematically verify that the information is complete and correct, and to fill in missing information where needed. This task requires strong familiarity with the UNIX command line, manual pages, and how to pipe input to/from applications in a variety of formats.
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... unit tests for LIBBN anim.c ====
 +
|}
 +
&nbsp;
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
  
Time: <3 days
+
*Useful resources
 +
  ->coming!
  
Code:
+
==== ... unit tests for LIBBN axis.c ====
* src/ .. everywhere
+
|}
 +
&nbsp;
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... unit tests for LIBBN qmath.c ====
 +
|}
 +
&nbsp;
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
  
References:
 
* Existing spreadsheet available on request
 
  
----
+
*Useful links and Resources
 +
-> Coming!
  
= Training =
+
==== ... unit tests for LIBBN rand.c ====
----
+
|}
''Tasks related to helping others learn more''
+
&nbsp;
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... unit tests for LIBBN vector.c ====
 +
|}
 +
|}
  
== LIBBU Doxygen cleanup ==
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
  
BRL-CAD uses Doxygen for most API documentation but the comment blocks are not optimally set up for Doxygen output.  There are approximately 300 documented API function calls in LIBBU.  
+
*Useful links and resources
 +
-> To be added.
  
This task involves cleaning up the Doxygen comments in the library so that useful reports and API documentation is automatically generated (correctly and completely).
+
=== Find, reliably reproduce, and report any bug in Archer ===
  
Time: <1 day
+
Archer is our new modeling interface and a soon to merge with our long-standing MGED geometry editor.  It undoubtedly has bugs.  It's your job to find one, but do so in a manner that is so obvious that one of the other devs will be able to instantly reproduce the bug given your specific instructions.  Find a way to make archer crash, become unresponsive, or otherwise behave incorrectly.  You will have to explore the tool with minimal documentation.
  
Code:
+
This task involves filing a bug report with verifiable and reproducible steps that clearly demonstrate the bug. It can't be a bug already reported or otherwise documented nor can it be merely behavior you don't like.
* include/bu.h
 
* src/libbu
 
* misc/Doxyfile
 
* ./configure --enable-documentation
 
  
 
References:
 
References:
* http://www.jiggerjuice.net/software/doxygen.html
+
* archer
* http://www.stack.nl/~dimitri/doxygen/starting.html
+
* Introduction to MGED at http://brlcad.org/wiki/Documentation (many of the mged commands are available in some fashion within archer)
* http://www.stack.nl/~dimitri/doxygen/
+
* BUGS file in any source/binary distribution
 +
* http://sourceforge.net/tracker/?atid=640802&group_id=105292&func=browse
 +
|}
  
== LIBBN Doxygen cleanup ==
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Reproduce any 10 unconfirmed open bug reports ===
  
BRL-CAD uses Doxygen for most API documentation but the comment blocks are not optimally set up for Doxygen outputThere are approximately 300 documented API function calls in LIBBN.  
+
BRL-CAD presently has approximately 75 open bug reports of which 50 are unassignedRead the comments and status to see if the bug has been confirmed/reproduced.
  
This task involves cleaning up the Doxygen comments in the library (i.e., all of the /** */ comments) so that useful reports and API documentation is automatically generated (correctly and completely).  The comments should be cleanly wrapped to column 70 with minimal or no embedded leading whitespace.
+
This task involves going through those reports and REPRODUCE at least 10 of the ones that have not been confirmed.  When you can reproduce the issue being reported, you'll comment on the thread to state as much and attach any data you used to reproduce the crash.
  
Time: <2 days
+
References:
 +
* https://sourceforge.net/tracker/?limit=100&func=&group_id=105292&atid=640802&assignee=100&status=1&submit=Filter
 +
|}
  
Code:
 
* include/bn.h
 
* include/plot3.h
 
* include/vmath.h
 
* src/libbn
 
* misc/Doxyfile
 
* ./configure --enable-documentation
 
  
References:
+
----
* http://www.jiggerjuice.net/software/doxygen.html
 
* http://www.stack.nl/~dimitri/doxygen/starting.html
 
* http://www.stack.nl/~dimitri/doxygen/
 
  
== LIBWDB Doxygen cleanup ==
+
== User Interface ==
 +
----
 +
''Tasks related to user experience research or user interface design and interaction''
  
BRL-CAD uses Doxygen for most API documentation but the comment blocks are not optimally set up for Doxygen output.  There are approximately 100 documented API function calls in LIBWDB.
 
  
This task involves cleaning up the Doxygen comments (i.e., all of the /** */ comments) in the library so that useful reports and API documentation is automatically generated (correctly and completely). The comments should be cleanly wrapped to column 70 with minimal or no embedded leading whitespace.
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create an ISST screenshot or animation ===
  
Time: <2 days
+
Everyone loves to see screenshots and animations of software in action. We use both in our marketing and outreach. See some of the examples below that we already have.
  
Code:
+
Create an awesome screenshot and/or animation of our 'isst' tool in action. It's an interactive geometry viewer interface.  It should be graphically interesting and give some sense of capability. You should import a visually complex and interesting model with LOTS of polygons and detail.
* include/wdb.h
 
* include/raytrace.h
 
* src/libwdb
 
* misc/Doxyfile
 
* ./configure --enable-documentation
 
  
 
References:
 
References:
* http://www.jiggerjuice.net/software/doxygen.html
+
* http://brlcad.org/gallery/d/19-4/MGED.jpg
* http://www.stack.nl/~dimitri/doxygen/starting.html
+
* http://brlcad.org/tmp/archer.png
* http://www.stack.nl/~dimitri/doxygen/
+
* http://brlcad.org/gallery/s/screenshots/
 +
* http://www.google-melange.com/gci/task/view/google/gci2012/8019211
  
== LIBRT Doxygen cleanup ==
+
Note that we have several screenshot tasks.  Note you may have to go through some or our basic MGED tutorials (see docs section on our website) just to be able to display geometry.  Finally, give others a chance if you already completed one of the other screenshot tasks. ;)
  
BRL-CAD uses Doxygen for most API documentation but the comment blocks are not optimally set up for Doxygen output.  There are approximately 1000 documented API function calls in LIBRT.
+
|}
  
This task involves cleaning up the Doxygen comments (i.e., all of the /** */ comments) in the library so that useful reports and API documentation is automatically generated (correctly and completely).  The comments should be cleanly wrapped to column 70 with minimal or no embedded leading whitespace.
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Categorize all of BRL-CAD's commands into a spreadsheet ===
  
Time: <4 days
+
BRL-CAD is a suite of more than 400 processing tools, image tools, geometry converters, and more. There is an existing spreadsheet that characterizes all of the available commands in terms of inputs, outputs, and options, but there is insufficient characterization of BRL-CAD's commands as to how they logically group and work together.
  
Code:
+
This task involves building up a spreadsheet that lists all of our commands, describing a finite set of command categories, and characterizing all commands into those categories while filling in the spreadsheet with details for each command.
* include/raytrace.h
 
* src/librt
 
* src/librt/primitives
 
* src/librt/comb
 
* src/librt/binunif
 
* misc/Doxyfile
 
* ./configure --enable-documentation
 
  
 
References:
 
References:
* http://www.jiggerjuice.net/software/doxygen.html
+
* A spreadsheet template will be provided.
* http://www.stack.nl/~dimitri/doxygen/starting.html
 
* http://www.stack.nl/~dimitri/doxygen/
 
  
== "Introduction to BRL-CAD Tutorial" ==
+
|}
  
BRL-CAD includes an extensive introduction to MGED tutorial series, but not a succinct introduction to BRL-CAD (the suite).
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Design a Cover Photo for Facebook page (and other social networks) ===
  
This task involves writing a brief introduction to BRL-CAD that highlights 10-20 of the core commands through an instructive tutorial. The tutorial should be brief, not exceeding 10 pages total.
+
BRL-CAD got it's logo changed, and it's website is undergoing a change. So this re-branding of BRL-CAD also requires a good, well designed and attractive cover photo for the BRL-CAD's Facebook page or other Social Media Appearances. It should feature a good tagline telling some killer feature of BRL-CAD, BRL-CAD's new logo and/or some illustration/image regarding the feature highlighted in tagline.
  
Time: <2 days
+
It should be consistent with the color scheme of our new website design.
  
== Write a "BRL-CAD Ray Tracing Shaders" tutorial ==
+
New website design
 +
*http://cpp-tricks.com/brlcad/
  
BRL-CAD includes numerous shaders that let you specify different optical effects during ray tracing.
+
|}
  
This task involves writing a brief tutorial that describes what shaders are and how one specifies them for geometry.  How shaders are specified is already described in detail in the [http://brlcad.org/w/images/c/cf/Introduction_to_MGED.pdf Introduction to MGED] document.
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
  
Time: <4 days
+
===  Design a banner ad for BRL-CAD ===
  
Code:
+
BRL-CAD is one of the oldest open source communities. This community has a good following, so we want to give a chance to everyone so that they can show their support to the community by adding a banner ad in their website. You have to create a banner ad that can be embedded in the website by copy pasting some simple lines of code (basically an iframe).
* src/liboptical/sh_*.(for available shader names and corresponding options)
 
  
References:
+
Such a banner ad can also be used in various sections of our own website.  
* http://brlcad.org/w/images/2/2c/Optical_Shaders.pdf
 
* http://brlcad.org/w/images/c/cf/Introduction_to_MGED.pdf
 
  
----
+
The task requires you to create a CSS3 based animated horizontal and vertical banner add, highlighting some feature of BRL-CAD or making some call to action. This call to action can be joining mailing list, or signing up for community, or link to latest post etc.
  
= User Interface =
+
For Inspiration and tutorial refer
----
+
*http://tympanus.net/Tutorials/AnimatedWebBanners/
''Tasks related to user experience research or user interface design and interaction''
 
  
== Design an MGED command spreadsheet ==
+
|}
  
BRL-CAD's primary solid geometry modeling application is called MGED.  MGED contains a comprehensive set of more than 700 commands for manipulating, viewing, and inspecting geometry. There is a need to more effectively manage those commands, characterize them all, and get a "big picture" of the command landscape so that usability may be addressed.
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Creating Motion Typography video for BRL-CAD  ===
  
This task involves designing a spreadsheet that will be used to characterize all of MGED's commands.
+
BRL-CAD has a lot of great features that can be highlighted. A motion typography video highlighting these features would be a wonderful addition to the front page of website.  
  
Time: <2 days
+
This task requires you to create a motion typography video that will convince user to give BRL-CAD a try, it could be titled something like "x reasons to choose BRL-CAD" or anything similar (give your creative minds a flight). The video should not be more than 2 minutes.
  
References:
+
For inspiration about what a motion typography, see
* An existing spreadsheet already being used for BRL-CAD (i.e., non-MGED) commands is available.
+
*http://vimeo.com/24715531
  
== Create prototype 2D CAD drawing(s) ==
+
|}
  
BRL-CAD provides limited services for drafting features including the production of 2D CAD drawings (blueprints).
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create a screen-cast for BRL-CAD ===
  
This task involves designing a 2D CAD drawing prototype that effectively captures a set of design requirements and follows industry conventions.  Basically, this requires identifying one or more style(s) of drawings that should be supported along with critical elements to be included on each drawing.
+
Getting started with BRL-CAD is sometimes not so smooth. A screen-cast giving a tour of BRL-CAD's GUI and the steps involved in creating the first model will make it easy for users to get started.  
  
Time: <3 days
+
For this task you need to install BRL-CAD on your computer. Create a very basic model in it and record your screen as you create the model. It should also give a tour of BRL-CAD's workspace. You can choose model of your choice. Keep something very basic and easy for the first time users.
  
References:
+
|}
* http://brlcad.org/design/drafting
 
* http://en.wikipedia.org/wiki/ISO_128
 
* http://en.wikipedia.org/wiki/ASME_Y14.41-2003
 
* http://en.wikipedia.org/wiki/Geometric_Dimensioning_and_Tolerancing
 
* http://www.ptc.com/WCMS/files/45691/en/4307_FoundationXE_DS.pdf
 
 
== Create prototype CAD GUI layout diagram ==
 
  
BRL-CAD's usability is notoriously complex and "expert friendly".  MGED and Archer are the main geometry editors, with drastically different user interfaces.
 
  
This task involves evaluating the features provided by MGED and Archer, then designing a new GUI layout that encompasses their features while improving usability.  Rationale for design decisions and layout should be provided.
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Loading Google charts from API  ===
  
Time: < 5 days
+
A basic wrapper of GCharts has been implemented a while ago : https://bitbucket.org/suryajith/benchmark/src/a27dd8c05d6819a527650e06a63076599d2e0d66/libs/charting.py?at=default With the google charts improving their API system which wasn't around then, see if the code could be optimized so to get the charts the optimal way.
  
References:
+
Reference:  
* http://brlcad.org/design/gui
+
*https://developers.google.com/chart/interactive/docs/index
  
== Reorganize MGED menu ==
 
  
BRL-CAD's main graphical user interface, MGED, is heavily menu-driven but not exceptionally well organized.  This task involves performing an exhaustive review of MGED's various menus, including temporary menus when in a given editing state, reorganizing them for logical groupings, and rewording them for clarity.  It's necessary to learn the basics of the MGED interface in order to understand what the various options do.
+
|}
  
For this task, you'll provide a description of the existing menus and mapping to a new organization including basic rationale behind any new groupings or rewording.
+
=== Design a hall of fame for BRL-CAD developers ===
  
Time <2 days
+
We love our developers and want to have a special place in it's website to thank and motivate hard working folks behind BRL-CAD. Your task would be to use an image manipulation software such as GIMP or Photoshop and design a hall of fame page for developers. It should have avatars and names of all the developers. For inspiration you can take a look at http://underscores.me/. You are free to experiment and design anyway you want, just make sure that the color scheme and font-scheme is consistent with the new BRL-CAD web design.
  
References:
+
Links:  
* Introduction to MGED at http://brlcad.org/wiki/Documentation
+
* http://cpp-tricks.com/brlcad/
 +
* http://underscores.me/
  
== Categorize all of BRL-CAD's commands into a spreadsheet ==
 
  
BRL-CAD is a suite of more than 400 processing tools, image tools, geometry converters, and more.  There is an existing spreadsheet that characterizes all of the available commands in terms of inputs, outputs, and options, but there is insufficient characterization of BRL-CAD's commands as to how they logically group and work together.
+
|}
 +
----
  
This task involves building up a spreadsheet that lists all of our commands, describing a finite set of command categories, and characterizing all commands into those categories while filling in the spreadsheet with details for each command.
+
= When You're Done =
 +
----
  
Time: <4 days
+
For non-code, just send us your file(s).  For code changes, you will be expected to [[Patches|provide a patch file]].  Make sure you ''read'' your patch file before submitting it.  Make sure your patch file will apply cleanly to an unmodified checkout of BRL-CAD:
  
References:
+
svn co https://brlcad.svn.sourceforge.net/svnroot/brlcad/brlcad/trunk brlcad.edit
* A spreadsheet template will be provided.
+
cd brlcad.edit
 +
# make changes
 +
svn diff > ~/my.patch
 +
# read ~/my.patch file with text editor
 +
cd ..
 +
svn co https://brlcad.svn.sourceforge.net/svnroot/brlcad/brlcad/trunk brlcad.fresh
 +
cd brlcad.fresh
 +
patch -p0 < ~/my.patch
 +
# submit your patch file to our patches tracker
 +
&nbsp;

Latest revision as of 10:29, 3 January 2020

This is a list of succinct tasks that are expected to take most people familiar with the prerequisites less than two hours to complete. It's a great starting point for anyone interested in contributing to BRL-CAD.

The tasks are all roughly the same complexity with no prior BRL-CAD experience expected. A description is provided along with a list of references and files you'll probably need to edit. Can we make it any easier?

Getting Started[edit]

Contact us (via IRC or brlcad-devel mailing list) if you have questions, comments, or ideas of your own you'd like to suggest.

We've made an awesome virtual disk image that has everything you need preconfigured and ready to go:

  1. Download our BRL-CAD Virtual Machine (VM) disk image.
  2. Install VirtualBox.
  3. Import and start the VM, log in (the password is "Brlcad!" without the quotes).
  4. Run "svn up brlcad-svn-trunk" and get started!

Pick a Task[edit]

We break down all tasks into one of five categories. Don't be worried if the tasks all sound confusing to you. Just pick one and start reading the references we've provided. Join IRC or our mailing list and ask questions.

  1. Code (programming)
  2. Documentation and Training (writing)
  3. Outreach and Research (graphics)
  4. Quality Assurance (testing)
  5. User Interface (designing)

Contents


Code[edit]


Tasks related to writing or refactoring code

See the When You're Done section above for details on submitting your changes.

 

Fix bounding box function for our polygonal mesh (BoT) primitive[edit]

BRL-CAD provides functions for its geometric primitives that define a bounding box - a box that completely encloses the volume described by the primitive. Ideally, these boxes are as small as possible while still enclosing the primitive. Currently the routine for BoTs is incorrect. You can use stl-g, obj-g, or any of our other *-g converters to import BoT geometry for testing.

This task involves studying the current code for the function rt_bot_bbox() and determining what is causing the current inaccuracies (the mged 'bb' command is a good way to visualize primitive bounding boxes). Make changes to produce a more optimal bounding box. Reimplement it from scratch if you like. The raytracing prep code in rt_bot_prep does prepare a better bounding box, so that is one place to check.

Code:

  • src/librt/primitives/bot/bot.c

   

Close MGED when both windows are closed[edit]

BRL-CAD has an interactive geometry editor called MGED. It's often the starting point for beginners and allows creation and manipulation of models using commands. When mged is run, it creates 2 windows: a text-console command window and an interactive graphics window. When the user closes one of those windows, there is a bug. Closing the graphics window closes the command window.

This task involves fixing this behavior so that ONLY closing both windows terminates the process properly and that closing either window does not take the other along with it.

Code:

  • src/mged/mged.c
  • src/tclscripts/mged/openw.tcl

 


Implement a primitive centroid function[edit]

BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones. Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid. Wikipedia, Wolfram Mathworld, and various other math sites (and research papers) around the web include the equations for most of our basic primitives while others are a little more tricky to compute.

This task involves writing a new callback function that takes an rt_db_internal object and calculates its centroid (as a point_t 3D point). There are numerous examples in our code where we compute centroids for other primitives. The primitives that do not already have a centroid callback are itemized in following.

References:

Code:

  • src/librt/primitives/table.c
  • src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c

 


Implement a primitive curvature function[edit]

BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones each described by a collection of callback functions, for example rt_sph_bbox() returns the bounding box dimensions for a sphere. Wikipedia, Wolfram Mathworld, and various other math sites (and research papers) around the web include the equations for most of our basic primitives while others are a little more tricky to compute.

This task involves writing the callback function rt_xxx_curve() that computes the curvature at a given point on the surface of a primitive such as;

  • superell
  • cline
  • extrude
  • grip
  • metaball
  • hrt.

There are numerous examples in our code where we compute the curvature for other primitives like the ellipsoid, sphere, elliptical parabola, etc.

References:

Code:

  • src/librt/primitives/table.c
  • src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c

 


Implement a primitive UV-mapping callback[edit]

BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones. Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid. One of those functions describes a UV mapping of the object's surface, which is used for things like texture and bump mapping. An example of this is rt_ell_uv() in the src/librt/primitives/ell/ell.c source file for an ellipsoid. Several of our more complex primitive types (such as BoT, NMG, and BREP/NURBS) do not presently implement a UV-mapping function leading to unexpected runtime behavior.

This task involves implementing a UV-mapping callback for any of the primitives that do not already have a functional UV-callback defined. Note that this is an advanced task that might take you more than a couple hours if you don't have solid coding skills, but it's ultimately just a few lines of code. See other primitives that already implement a UV-mapping callback for reference.

References:

... UV-mapping for extruded sketches (EXTRUDE)[edit]

Code:

  • src/librt/primitives/extrude/extrude.c
  • src/librt/primitives/table.c
  • include/rtgeom.h

 

   

Implement a platform independent re-entrant sort function[edit]

The classic C library qsort() does not support a context parameter. A work around is to store the context information in a static variable. However, this solution is not thread save and may result in unpredictable behavior.

There are platform specific sort functions qsort_r() in incompatible versions for BSD and GNU and qsort_s() for MSVC. Your task is to implement a bu_sort() function for BRL-CAD which is platform independent.

Code:

  • src/libbu/sort.c

The new sort function could look like this:

void bu_sort(genptr_t array, size_t nummemb, size_t sizememb, int (*compare)(const_genptr_t, const_genptr_t, genptr_t), genptr_t context);

 


|}    

Solve fonts related bug in new wiki theme[edit]

BRL-CAD has been working on a new incarnation of the website and has developed a new wiki theme and wordpress theme. Wiki theme uses a font called 'open-sans' from google fonts directory. It's linked via CSS but it does not get loaded (we still see default serif all over the place). So your task will be to debug the CSS code and get Open Sans loaded.

Links:

 


   

Better placement of icons in wiki theme[edit]

BRL-CAD has been working on a new incarnation of the website and has developed a new wiki theme and wordpress theme. Wiki theme is responsive but has a small styling problem. On smaller screens icons near the search bar gets misplaced and unaligned. Your task would be to fix that. Task would include diving into sass file that corresponds to styling of this part of theme (given below) and adjusting spacing between icons to keep them aligned even at smaller screens.

Links:

 


Documentation and Training[edit]


Tasks related to creating/editing documents and helping others learn more about BRL-CAD

Add missing documentation (for any ONE command)[edit]

BRL-CAD is an extensive system with more than 400 commands and more than a million pages of documentation, but there are approximately 120 commands that are entirely undocumented:

a-d archer asc2g asc2pix bot-bldxf bottest brep_cube brep_simple brickwall btclsh burst bw-a bw-d bwish c-d chan_add clutter contours d-a damdf dauto dauto2 d-bw dconv ddisp d-f dfft d-i dmod double-asc dpeak dsel dsp_add dstat d-u dwin euclid_format euclid_unformat fbgammamod f-d fence fhor f-i g-adrt g-euclid1 g-jack globe g-off i-a i-d i-f ihist imod istat jack-g kurt lowp molecule nmgmodel nmg-sgp off-g pipe pipetest pix2g pix3filter pixcount pixelswap pixembed pixfields pixfieldsep pixflip-fb pixpaste pix-spm pix-yuv plstat pyramid rawbot remapid rlesortmap rletovcr room rtcell rtexample rtfrac rtrad rtsil rtsrv script-tab sketch solshoot sphflake spltest spm-fb ssampview syn tea tea_nmg testfree texturescale torii ttcp tube txyz-pl u-a u-bw u-d u-f umod ustat vcrtorle vegitation wall wdb_example xbmtorle xyz-pl yuv-pix

This task involves writing basic documentation for JUST ONE of those commands in the Docbook XML format. The command documentation should provide a one-sentence description, a detailed paragraph description (200+ words), explanation of all available command-line options, and one or more examples on how to use the command.

Code:

  • doc/docbook/system/man1/en/Makefile.am
  • doc/docbook/system/man1/en/*.xml

 

Write an article "BRL-CAD for dummies"[edit]

Although BRL-CAD has extensive documentation, still it needs a short and simple document which is particularly built for dummies.

This task involves writing a article named BRL-CAD for dummies. This article should start with the installation process, if there is any existing installation guide for dummies, provide a link to it. The main motive of this article to empower dummy to make his/her first model using BRL-CAD. One thing to be kept in mind while writing this article is that this article is mainly concentrated for dummies. So use simple language to an extent and if you need to mention some technical term, first explain that term.

The output of this task can be a pdf, html, doc, odt or any other document file that contains this article. Go through the link provided. Use screenshots and images to make it look attractive so that the reader is not bored.

Reference:

 

Translate "Contributors Guide To BRL-CAD" To Any Language[edit]

People interested in improving BRL-CAD sometimes find themselves lost in a sea of information. In all, BRL-CAD has more than a million words of documentation across hundreds of manual pages, dozens of tutorials and examples, hundreds of wiki pages, dozens of technical papers, and other resources. There are literally thousands of features and this can sometimes pose problems.

In 2013, a team of contributors got to California and worked on an entire book titled "Contributors Guide To BRL-CAD" in just a few days. This great resource needs to be translated to other languages to attract developers from other lingual backgrounds (who don't read English ) to contribute to BRL-CAD.

This task involves translating the chapters/sections of the "Contributors Guide To BRL-CAD" into a language of your choice such as Mandarin, French, Chinese, Spanish, German, Hindi, Arabic, Russian, etc. Chapters/Sections include

  • Feature Overview
  • Working with our Code
  • What code to work on
  • How to contribute
  • .... (Just to name a few )

The output of this task can be a pdf, html, doc, odt or any other document file that contains the translated article.Images in the original document (see link in Reference below) should not be changed ! only text should be.

Reference:

 


Write a "BRL-CAD Commands Quick Reference" document[edit]

There is already a command quick reference for BRL-CAD's MGED geometry editing tool, but there is not a similar document for BRL-CAD's 400+ command-line commands.

This task involves writing a quick reference document similar to the MGED quick reference but for BRL-CAD commands. The sheet should minimally include the following commands:

mged, rt*, *-g, g-*, fb*, *fb, nirt, remrt, rtsrv, asc2g, g2asc, dbupgrade, pix*, *pix, *-*, brlman, benchmark

References:

 

Doxygen cleanup[edit]

BRL-CAD uses Doxygen for most API documentation but the comment blocks are not optimally set up for Doxygen output.

This task involves cleaning up the Doxygen comments in the library so that useful reports and API documentation automatically generated (correctly, completely, and cleanly). Verify/fix any Doxygen syntax. Verify/fix groups so that functions are organized neatly and all contained within a group. Provide patches that give clean (PDF) output from Doxygen.

References:

... doxygen cleanup for LIBBU[edit]

There are approximately 300 documented API function calls in LIBBU.

Code:

  • include/bu.h
  • src/libbu
  • misc/Doxyfile

 

... doxygen cleanup for LIBWDB[edit]

There are approximately 100 documented API function calls in LIBWDB.

Code:

  • include/wdb.h
  • include/raytrace.h
  • src/libwdb
  • misc/Doxyfile

 

... doxygen cleanup for LIBRT[edit]

There are approximately 1000 documented API function calls in LIBRT.

Code:

  • include/raytrace.h
  • src/librt
  • src/librt/primitives
  • src/librt/comb
  • src/librt/binunif
  • misc/Doxyfile

 

Write up Wiki page tutorial on our Volumetric Primitive[edit]

BRL-CAD provides a couple dozen distinct primitives. Each primitive is defined by a set of parameters. Several of the more complex primitives have a wiki page describing them in more detail with an example on how to create them.

This task involves writing up a page on the VOL primitive. Figure out how to use it (see the "in" command), create an example input data set, and write up a wiki page on exactly what steps are needed similar to our other wiki pages:

References:

Show how to create a VOL with at least two layers/slices. Include images like the other examples. Put the write-up at http://brlcad.org/wiki/VOL

 

Write a wiki tutorial on how to create a polygonal mesh (NMG) manually[edit]

BRL-CAD provides a couple dozen distinct primitives. Each primitive is defined by a set of parameters. Several of the more complex primitives have a wiki page describing them in more detail with an example on how to create them.

This task involves writing up a page on the NMG polygonal mesh primitive. Figure out how to use it (not a simple task, will require some trial and error), create an example input, and write up a wiki page on exactly what steps are needed similar to our other wiki pages:

References:

Note the "facetize" command in mged will convert an existing object into NMG format. The get/put commands should help from there like the sketch tutorial.

Show how to create an NMG cube or wedge or similar simple shape. Include images like the other examples. Put the write-up at http://brlcad.org/wiki/NMG

 

Fix Image Formatting in BRL-CAD's DocBook Documentation (any ONE large document or 4 smaller documents)[edit]

The majority of BRL-CAD's documentation is defined as DocBook files, from which other formats (HTML, PDF, man page, etc.) can be generated. PDF files present a particular challenge, and have some very specific requirements to achieve "good" formatting.

BRL-CAD's DocBook files need to uniformly use a style of image inclusion that is aware of what "role" the image is supposed to serve. A "basic" image inclusion example looks like this:

 <mediaobject>
   <imageobject>
     <imagedata align="center" fileref="../../lessons/en/images/img.png" format="PNG"/>
   </imageobject>
   <caption>
     <para>
       Caption goes here.
     </para>
   
 </mediaobject>

This task involves switching image inclusions that use the above style to something like the following:

 <mediaobject>
   <imageobject role="html">
     <imagedata align="center" fileref="../../books/en/images/img.png" format="PNG"/>
   </imageobject>
   <imageobject role="fo">
     <imagedata align="center" fileref="../../books/en/images/img.png" format="PNG"/>
   </imageobject>
   <caption>
     <para>
       Caption goes here.
     </para>
   
</mediaobject>

The "role" flag to imageobject provides the opportunity to specify different image formatting options when the output is HTML (role="html") or PDF (role="fo").

The captions should be preserved as above on mediaobjects that have them, but mediaobjects without a caption should also be converted and there is no need to add a caption in such cases.

Any patch that makes changes to the DocBook sources should result in a successful "make doc" build test. This won't generate PDF documents, but it will validate the XML files and produce HTML - remember that introducing breakage means the patch won't be accepted.

Remember, the tasks are simply to do the above conversion for all images in the file or files, not to introduce PDF specific formatting. Formatting fixes will be needed, but they are very much "case by case" and will take both additional time and a working Apache FOP installation, as well as knowledge of how to enable PDF generation. If all image inclusions have been converted successfully and a student is interested in actually fixing the formatting, please discuss it with us on IRC or the mailing list.

References:

  • doc/docbook/books/en/BRL-CAD_Tutorial_Series-VolumeIII.xml

Code:

  • doc/docbook

 

Make a step by step tutorial for creating BRL-CAD model[edit]

BRL-CAD is said to have an expert friendly User Interface so new users mostly have a tough time getting around it's UI and making models. So anything link Django poll app tutorial https://docs.djangoproject.com/en/dev/intro/tutorial01/ would be very helpful.


 

Find 5 bugs in OGV[edit]

Online Geometry Viewer is a web based application with which you can see 3D .g models in browser without the use of any plugins. Your task will be to deploy OGV locally and find 5 bugs or errors in it.

Links: https://github.com/BRL-CAD/OGV-meteor/

 

Find 5 coding guidelines violations in OGV[edit]

Online Geometry Viewer is a web based application with which you can see 3D .g models in browser without the use of any plugins. Your task will be to deploy OGV locally, look into code and see if any coding guidelines are violated.

Links: https://github.com/BRL-CAD/OGV-meteor/

 


Outreach and Research[edit]


Tasks related to community management, outreach/marketing, studying problems, and recommending solutions

 

Profile NURBS prep performance[edit]

BRL-CAD implements support for rendering of NURBS representation geometry. If you import a solid 3DM or STEP format model into BRL-CAD, it will import as BREP/NURBS geometry. Opening that geometry in BRL-CAD's MGED editor will tell you what objects are available and our 'rt' tool will raytrace it. When geometry is ray traced, it first goes through a "prep" phase and then it starts shooting rays. Our prep phase is entirely unoptimized so we'd like to know where all the time is presently being spent during prep..

This task involves importing some NURBS geometry into BRL-CAD and ray tracing that geometry with a profiler watching our prep performance. Any profiler will do, including gprof, but a performance monitor like oprofile or the Mac "Instruments" application (or Shark) are preferred.

Learning how to use a profiler is beyond the scope of this task, so it make take you considerably longer to provide us with useful information if you've never run a profiler before.

To capture prep performance, you will need to import some fairly complex geometry. You should be able to search google with "filetype:3dm" or "filetype:step" or find something on grabcad.com to import

Running "tops" within mged will tell you what geometry is available for rendering.

Running "rt -o file.png -s32" on the system command line (not inside mged) should minimize the ray overhead or you can specifically isolate the prep phase we care about. Prep is the time between when rt is run where it opens a window until the first pixels are fired and pixels start filling in.

 

Continue investigating GMP integration[edit]

BRL-CAD uses a fastf_t typedef for most all math operations that is usually a "double" floating point type. We would like to provide the option for resorting to exact arithmetic if possible by merely redefining fastf_t to a C++ type sufficiently overloaded to behave the same. You should be proficient with C++ operator overloading to take this work on. This task is a continuation of a prior GCI task (read it in full!):

http://www.google-melange.com/gci/task/view/google/gci2012/7946218

This task involves testing compilation with a C++ class with overloaded operators such that vmath macro calls still work as well as a sampling of LIBBN API function calls without major changes to the original code. A perfect example case study would be creating the class then testing whether bn_dist_pt3_pt3() and bn_mat_determinant() compute correctly for values that cannot be exactly represented with floating point arithmetic.

Building on the previous GCI task work, take it to the next step. Try setting a vector to 1/3, 1/3, 1/3 and 0.1, 0.1, 0.1 and get proper values to print. Change the V3ARGS() macro if needed. If that all works, try to get bn_dist_pt3_pt3() to work. Report and discuss your progress.

 

Design a T-Shirt for BRL-CAD[edit]

This task involves designing a T-Shirt for BRL-CAD. Use your designing skills to design a T-Shirt for BRL-CAD. You can use the current BRL-CAD logo, or you may tweak it. Be creative while designing this T-Shirt. It would be good if the design has some special meaning.

Logo References

 

Design a coffee mug for BRL-CAD[edit]

This task involves designing a coffee mug for BRL-CAD. Make it look good, so that one can use it while working on BRL-CAD. Look over some great coffee mug designs before starting to work on this. It would be great if the design on coffee mug has some special meaning.

Logo References

 

Design BRL-CAD sticker[edit]

This task involves designing a BRL-CAD sticker. The design should be simple and sleek. The concept of sticker should be clear and also it should be creatively presented. Get inspired from some sticker designs but choose your own imagination while designing the sticker. There is no bound for shape of sticker, it can be rectangular, circular or even irregular. The only thing that matters is that it should look good.

Logo References

 

Design BRL-CAD phone/tablet back cover[edit]

This task involves designing a BRL-CAD phone/tablet cover. While submitting your design, provide the sample phone cover, tablet cover with the design and rendered png or jpg image of the sticker design. Try to have a special meaning of design, and the concept should be creatively illustrated.

Logo References

 

Design a wallpaper set for BRL-CAD[edit]

This task involves designing a set of wallpapers for BRL-CAD. The central idea of each wallpaper should represent any feature of BRL-CAD. Try to design a minimum of 5 wallpapers but if you have more than 5 designs than you are welcomed.

Try to different resolutions of each wallpaper.

Check the following wallpapers for inspiration.

Logo References


 

Create Iron Man Arc Reactor Model in BRL-CAD[edit]

This task involves creating Arc Reactor as seen in hollywood movie Iron-Man. You will have to create two versions of the Arc Reactor one glowing and another non glowing.

Check this model for inspiration



 

Tweak BRL-CAD logo to wish New Year[edit]

You might have heard and praised those google doodles we occasionally see on google.com on special days. This task is all about tweaking BRL-CAD logo to wish New Year. You may have a look at google doodles but don't entirely copy their style. I am sure your creative mind will get something much better. Make sure this tweak should be tweaked version of current logo and not entirely new logo.

Tip: Search for some global events occurring in 2015 and design accordingly. Also keep the letters 2,0,1,5 in mind while designing. ;)

Also output of this task shall be the png file of your work and the raw file but don't upload the raw file(.psd, .xcf or some other) for review of this task. We will ask for it later, when the design is finalized.

Gallery of all google doodles



 

Tweak BRL-CAD logo to wish Merry Christmas[edit]

You might have heard and praised those google doodles we occasionally see on google.com on special days. This task is all about tweaking BRL-CAD logo to wish Christmas. You may have a look at google doodles but don't entirely copy their style. I am sure your creative mind will get something much better. Make sure the output of this task should be tweaked version of current logo and not entirely new logo.

Also output of this task shall be the png file of your work and the raw file but don't upload the raw file(.psd, .xcf or some other) for review of this task. We will ask for it later, when the design is finalized.

Gallery of all google doodles



Quality Assurance[edit]


Tasks related to testing and ensuring code is of high quality

Fix single-precision floating point crash[edit]

By default, all of BRL-CAD compiles using double-precision floating point arithmetic. We provide a simple typedef, however, that converts almost the entire system over to single-precision floating point. This compilation mode was recently cleaned up and tested, but a bug was found. The problem is reproduced very simply by compiling in single precision mode and running our "rt" ray tracer tool.

To compile in single precision, edit the include/bn.h header file and change the fastf_t typedef from double to float. To reproduce the bug, compile BRL-CAD and write this out to a text file named star.view:

viewsize 2.500000000e+05;
eye_pt 2.102677960e+05 8.455500000e+04 2.934714650e+04;
viewrot -6.733560560e-01 6.130643360e-01 4.132114880e-01 0.000000000e+00
        5.539599410e-01 4.823888300e-02 8.311441420e-01 0.000000000e+00
        4.896120540e-01 7.885590550e-01 -3.720948210e-01 0.000000000e+00
        0.000000000e+00 0.000000000e+00 0.000000000e+00 1.000000000e+00 ;
start 0;
end;

Then run rt feeding it that view script as input. This is an example how to run within the gdb debugger:

gdb path/to/bin/rt
...
(gdb) run -F/dev/X -M .cmake/share/db/star.g all < star.view

At this point, rt should crash due to an infinite recursion. A backtrace in the debugger will show lots and lots of calls to rt_shootray() and light_hit().

This task involves investigating and preventing the crash. Provide a patch that fixes the bug.

References:

  • man gdb
  • brlman rt

Code:

  • src/librt/shoot.c
  • src/liboptical/sh_light.c

 

Fix closedb[edit]

BRL-CAD geometry editor application (mged) has several hundred commands including two very simple commands for opening and closing a geometry database file. While the user rarely ever needs to close the file, as all changes are always immediately saved, it can be of use to scripting applications. However, at some point in the recent past, the closedb command was horked. It's undoubtedly something very simple but we haven't bothered to look due to other priorities. You can fix it. If you run these simple steps within graphical mged, you should see how commands stop working after calling closedb:

 mged> opendb test.g y
 mged> make sph sph
 mged> l sph
 mged> closedb
 mged> make sph sph
 mged> opendb test.g
 mged> l sph
 mged> exit

Provide a patch that fixes the bug or tell us which SVN revision introduced the bug. Make sure you can reproduce the bug before claiming this task, which presumes you know how to download/install BRL-CAD from a source distribution.

Code:

  • src/mged/mged.c

 

Create a utility library (LIBBU) API unit test[edit]

There are more than 300 library functions in our core LIBBU library. As a core library used by nearly every one of BRL-CAD's tools, testing those functions for correct behavior is important.

This task involves implementing new unit tests for any of LIBBU's source files that do not already have a unit test defined. The test should run all of the public functions and be hooked into our build system. We have lots of existing unit tests to follow as examples.

References:

  • include/bu.h
  • src/libbu/*.c
  • src/libbu/tests/*.c

Code:

  • src/libbu/tests/[TEST].c
  • src/libbu/tests/CMakeLists.txt


... unit test for LIBBU bomb.c[edit]

 

Create Numerics library (LIBBN) API unit tests[edit]

There are more than 300 library functions in our core LIBBN library. As a core library used by nearly every one of BRL-CAD's tools, testing those functions for correct behavior is important.

This task involves implementing new unit tests for any of LIBBN's source files that do not already have a unit test defined. The test should run all of the public functions and be hooked into our build system. We have lots of existing unit tests to follow as examples.

References:

  • include/bn.h
  • include/plot3.h
  • include/vmath.h
  • src/libbn/*.c
  • src/libbn/tests/*.c <-- check this directory for examples
  • src/libbu/tests/*.c <-- Note: Also check this too for more examples.

Code:

  • src/libbn/tests/[TEST].c
  • src/libbn/tests/CMakeLists.txt

Note A valid task will constitute writing a basic test for each function in the following libbn/ files.

... unit tests for LIBBN anim.c[edit]

 

  • Useful resources
 ->coming!

... unit tests for LIBBN axis.c[edit]

 

... unit tests for LIBBN qmath.c[edit]

 


  • Useful links and Resources
-> Coming!

... unit tests for LIBBN rand.c[edit]

 

... unit tests for LIBBN vector.c[edit]

 

  • Useful links and resources

-> To be added.

Find, reliably reproduce, and report any bug in Archer[edit]

Archer is our new modeling interface and a soon to merge with our long-standing MGED geometry editor. It undoubtedly has bugs. It's your job to find one, but do so in a manner that is so obvious that one of the other devs will be able to instantly reproduce the bug given your specific instructions. Find a way to make archer crash, become unresponsive, or otherwise behave incorrectly. You will have to explore the tool with minimal documentation.

This task involves filing a bug report with verifiable and reproducible steps that clearly demonstrate the bug. It can't be a bug already reported or otherwise documented nor can it be merely behavior you don't like.

References:

 

Reproduce any 10 unconfirmed open bug reports[edit]

BRL-CAD presently has approximately 75 open bug reports of which 50 are unassigned. Read the comments and status to see if the bug has been confirmed/reproduced.

This task involves going through those reports and REPRODUCE at least 10 of the ones that have not been confirmed. When you can reproduce the issue being reported, you'll comment on the thread to state as much and attach any data you used to reproduce the crash.

References:



User Interface[edit]


Tasks related to user experience research or user interface design and interaction


 

Create an ISST screenshot or animation[edit]

Everyone loves to see screenshots and animations of software in action. We use both in our marketing and outreach. See some of the examples below that we already have.

Create an awesome screenshot and/or animation of our 'isst' tool in action. It's an interactive geometry viewer interface. It should be graphically interesting and give some sense of capability. You should import a visually complex and interesting model with LOTS of polygons and detail.

References:

Note that we have several screenshot tasks. Note you may have to go through some or our basic MGED tutorials (see docs section on our website) just to be able to display geometry. Finally, give others a chance if you already completed one of the other screenshot tasks. ;)

 

Categorize all of BRL-CAD's commands into a spreadsheet[edit]

BRL-CAD is a suite of more than 400 processing tools, image tools, geometry converters, and more. There is an existing spreadsheet that characterizes all of the available commands in terms of inputs, outputs, and options, but there is insufficient characterization of BRL-CAD's commands as to how they logically group and work together.

This task involves building up a spreadsheet that lists all of our commands, describing a finite set of command categories, and characterizing all commands into those categories while filling in the spreadsheet with details for each command.

References:

  • A spreadsheet template will be provided.

 

Design a Cover Photo for Facebook page (and other social networks)[edit]

BRL-CAD got it's logo changed, and it's website is undergoing a change. So this re-branding of BRL-CAD also requires a good, well designed and attractive cover photo for the BRL-CAD's Facebook page or other Social Media Appearances. It should feature a good tagline telling some killer feature of BRL-CAD, BRL-CAD's new logo and/or some illustration/image regarding the feature highlighted in tagline.

It should be consistent with the color scheme of our new website design.

New website design

 

Design a banner ad for BRL-CAD[edit]

BRL-CAD is one of the oldest open source communities. This community has a good following, so we want to give a chance to everyone so that they can show their support to the community by adding a banner ad in their website. You have to create a banner ad that can be embedded in the website by copy pasting some simple lines of code (basically an iframe).

Such a banner ad can also be used in various sections of our own website.

The task requires you to create a CSS3 based animated horizontal and vertical banner add, highlighting some feature of BRL-CAD or making some call to action. This call to action can be joining mailing list, or signing up for community, or link to latest post etc.

For Inspiration and tutorial refer

 

Creating Motion Typography video for BRL-CAD[edit]

BRL-CAD has a lot of great features that can be highlighted. A motion typography video highlighting these features would be a wonderful addition to the front page of website.

This task requires you to create a motion typography video that will convince user to give BRL-CAD a try, it could be titled something like "x reasons to choose BRL-CAD" or anything similar (give your creative minds a flight). The video should not be more than 2 minutes.

For inspiration about what a motion typography, see

 

Create a screen-cast for BRL-CAD[edit]

Getting started with BRL-CAD is sometimes not so smooth. A screen-cast giving a tour of BRL-CAD's GUI and the steps involved in creating the first model will make it easy for users to get started.

For this task you need to install BRL-CAD on your computer. Create a very basic model in it and record your screen as you create the model. It should also give a tour of BRL-CAD's workspace. You can choose model of your choice. Keep something very basic and easy for the first time users.


 

Loading Google charts from API[edit]

A basic wrapper of GCharts has been implemented a while ago : https://bitbucket.org/suryajith/benchmark/src/a27dd8c05d6819a527650e06a63076599d2e0d66/libs/charting.py?at=default With the google charts improving their API system which wasn't around then, see if the code could be optimized so to get the charts the optimal way.

Reference:


Design a hall of fame for BRL-CAD developers[edit]

We love our developers and want to have a special place in it's website to thank and motivate hard working folks behind BRL-CAD. Your task would be to use an image manipulation software such as GIMP or Photoshop and design a hall of fame page for developers. It should have avatars and names of all the developers. For inspiration you can take a look at http://underscores.me/. You are free to experiment and design anyway you want, just make sure that the color scheme and font-scheme is consistent with the new BRL-CAD web design.

Links:



When You're Done[edit]


For non-code, just send us your file(s). For code changes, you will be expected to provide a patch file. Make sure you read your patch file before submitting it. Make sure your patch file will apply cleanly to an unmodified checkout of BRL-CAD:

svn co https://brlcad.svn.sourceforge.net/svnroot/brlcad/brlcad/trunk brlcad.edit
cd brlcad.edit
# make changes
svn diff > ~/my.patch
# read ~/my.patch file with text editor
cd ..
svn co https://brlcad.svn.sourceforge.net/svnroot/brlcad/brlcad/trunk brlcad.fresh
cd brlcad.fresh
patch -p0 < ~/my.patch
# submit your patch file to our patches tracker