What to include in a zip file, and what to leave out

A collection of noteworthy items selected by our moderators from discussions about making and using models with NEURON.

Moderators: wwlytton, tom_morse

Post Reply
ted
Site Admin
Posts: 5529
Joined: Wed May 18, 2005 4:50 pm
Location: Yale University School of Medicine
Contact:

What to include in a zip file, and what to leave out

Post by ted » Sat Aug 19, 2006 1:48 am

If you need to send program files to someone else, the best thing to do is put them in a directory and zip up that directory. It is best to avoid other archive formats, e.g. sit or bzip or rar, because you can't count on everyone being able to extract the files.

What files to include? Any source code that your program needs, like hoc, mod, ses, and py files. If some of the necessary files have strange extensions like oc or tem, please include those too. And of course include any data files that your program needs to read.

Please avoid anything that is specific to a particular OS or version of NEURON. Mostly this means don't include anything that was generated by compiling mod files.
MSWin users: please do not include .o, .c, .dll, or .bak files.
UNIX/Linux users: please do not include .i686 or .x86_64 subdirectories.
OS X users: no .dlls please or .x86_64 subdirectories. Also, no __MACOSX directories.

It may be appropriate to include a plain (ASCII) text file that contains usage instructions or a problem description. PDFs are only rarely useful. Never include MicroSoft Word files.

In general it is not necessary to include screenshots or other graphics files. In unusual cases, a gif may be OK, but do not include space-hogging .bmp or .jpg files.

Updated 20150227 NTC

ted
Site Admin
Posts: 5529
Joined: Wed May 18, 2005 4:50 pm
Location: Yale University School of Medicine
Contact:

Re: What to include in a zip file, and what to leave out

Post by ted » Fri Mar 13, 2015 10:28 am

Also do not include any other "hidden" directories, such as .hg

Post Reply