[ADMB Users] user-generated documentation of ADMB

[John Sibert]

Hi Ian,

Thanks for your questions.

I think a new introductory document is in the works. Mark Schildhauer 
from NCEAS has commissioned something but I haven't seen a copy nor do I 
know its status.

We are in the process of simplifying the production of LaTeX 
documentation with a new ADMB style package. Work progressing well and 
the package should be available in January.

If you have useful information to share from you exploration of the 
code, adding comments to the API documentation would be very helpful. 
You can see the draft API documentaion at 
http://admb-project.org/documentation/api/Doxygen/

Finally, the Community pages are intended for contributions from users. 
So anything you feel might be helpful to others would be welcome. These 
pages seem a bit disorganized to me and some are out of date, but they 
are probably useful nevertheless.

Cheers,
John

Ian Taylor wrote:
> With the source code available and the user community growing, it 
> seems that there's a lot of potential for expanding the ADMB 
> documentation in areas like the one Hans described, where the current 
> information is brief. Arni noted the potential for user-generated 
> contributions to the source code, but it seems to me that the 
> documentation is be even easier to contribute to. I've certainly 
> benefited from searching the source code for information about how 
> specific calculations are carried out and I think a bunch of users 
> sharing such information would be a real benefit.
>
> This raises two questions for me. First, might there be a division in 
> the future between the "Introduction to ADMB" document and a more 
> technical document? Second, how best might the community take note of 
> findings and understandings in a less formal way than proposing 
> specific changes to the official ADMB documentation? Are the 
> "community" pages at admb-project.org <http://admb-project.org/> the 
> place to go?
> -Ian
>
>
> H. Skaug wrote:
>> Hi,
>>
>> About this issue (for SEPARABLE FUNCTIONs) the manual says:
>>
>> "Objects defined in the PARAMETER SECTION must be passed as arguments
>> to g_cluster. There is one exception: the objective function g is a
>> global object, and does not need to be an argument."
>>
>> I do not know the details of how this works. Look at a few examples
>> to see how it is done.
>>
>> Hans
>>
>>   
>>> Another strange thing is that if I try printing the value of the
>>>  objective_function_value g;
>>> in a SEPARABLE_FUNCTION
>>> it has the value zero there and is actually set to zero
>>> but then returns what it is assigned in the function
>>> so it is not like a local variable.
>>> If the function is not separable this does not happen.
>>>
>>>     
>> _______________________________________________
>> Users mailing list
>> Users at admb-project.org
>> http://lists.admb-project.org/mailman/listinfo/users
>>   
> ------------------------------------------------------------------------
>
> _______________________________________________
> Users mailing list
> Users at admb-project.org
> http://lists.admb-project.org/mailman/listinfo/users
>   

-- 
John Sibert
Emeritus Researcher, SOEST
University of Hawaii at Manoa

Visit the ADMB project http://admb-project.org/