مستندات GAMS

مستندات GAMS نسبت به زمان اولین انتشار آن که در سال ۱۹۸۸ بوده، بسیار تغییر کرده است. این تغییرات را می توان در قالب، محدوده و محتوا ، و نحوه توزیع و دسترسی به آن دید. در عین حال ، بسیاری از عناصر سبک اصلی را حفظ کرده اند مانند: بخشی از آموزش، بخشی از راهنمای کاربران و بخشی از کتابچه راهنمای مرجع. ما در اینجا تکامل اسناد GAMS و موضوعات مرتبط را شرح می دهیم.

اولین مستندات منتشر شده GAMS کتاب GAMS: A User’s Guide (معروف به “کتاب قرمز”) توسط بروک ، کندریک و میراوس است که در سال ۱۹۸۸ توسط The Scientific Press منتشر شد. نسخه ها در کتابفروشی ها فروخته می شوند و شامل یک فصل در مورد کتابخانه مدل (۱۰۰ مدل در آن زمان) ، یک شاخص بسیار مورد استقبال و بسیار مورد استفاده ، ضمایم حل کننده های موجود (MINOS و ZOOM) ، و یک فلاپی دیسک ۵.۲۵ اینچی حاوی یک نسخه دانشجویی “PC-GAMS نسخه ۲.۰۵” بود. این مورد در سال ۱۹۹۲ با GAMS: A User Guide ، Release 2.25 (معروف به “کتاب آبی”) توسط ناشری متفاوت (Boyd & Fraser)، یک جلد نرم و بدون فلاپی دیسک ادامه پیدا کرده است. از GAMS بخش پایانی یادداشت های نصب در کتاب قرمز در کتاب آبی با یادداشت هایی در مورد ویژگی های جدید GAMS 2.25 جایگزین شد ، اما محتوای دیگر تغییر نکرده است.

با افزایش سرعت توسعه و بهبود و پیرفت این نرم افزار، مشخص شد که به یک سند جدید نیاز است، طرحی که این امکان را بدهد که سند به طور مداوم به روز شود، زیرا ویژگی های زبان ، مدل ها و کتابخانه های مدل، حل کننده ها، و ابزارهای کمکی به برنامه اضافه می شوند یا به روز می شوند. در نتیجه ، اسناد موجود توسط تیم GAMS را به MS Word تبدیل شد و با توجه به تغییرات گسترش پیدا کرد و در صورت لزوم ویرایش شد. این یک تلاش گروهی به رهبری رامش رامان بود ، که نام او به عنوان نویسنده در راهنمای کاربر گنجانده شد که ابتدا (همراه با CD) در محموله های نسخه ۱۸.۰ ما در فوریه ۱۹۹۹ گنجانده شد. کتابچه های راهنمای حل کننده در این نسخه از منابع مختلف جمع آوری شده است (با سبک ها ، محتوا و سازمان های مختلف) و در یک پیوست جداگانه قرار داده شد. برای یکپارچه سازی این اسناد حل کننده (با استفاده از LaTeX) برای استفاده از سبک و سازمان متداول ، فشار بیشتری لازم بود: این دفترچه راهنمای حل کننده یکپارچه با نسخه ۲۱.۰ از مه ۲۰۰۳ ارائه شد. علاوه بر نسخه کپی ، همه این اسناد به عنوان PDF در سیستم GAMS و آزادانه از طریق وب در دسترس است.

در این مدت ، بروس مک کارل به طور منظم دوره های GAMS را آموزش می داد: عمومی و پیشرفته ، مخاطبان عام را هدف قرار می داد اما دارای گرایش اقتصاد کشاورزی بود. او مطالب دوره را برای استفاده در کلاسهای خود توسعه داد و در همین هنگامبود که متوجه شد راهنمای کاربر GAMS با تمام به روزرسانی های نرم افزار مطابقت ندارد. با تشویق GAMS ، بروس پروژه بلندپروازانه ایجاد راهنمای کاربر جدید GAMS را آغاز کرد. راهنمایی که با سلیقه او با افزایش گرایش به آموزش و طراحی شده برای استفاده کامل از سند وب: پیوند داده شده ، قابل ارجاع، قابل جستجو و فهرست بندی شدهکامل شود. نتیجه نهایی راهنمای مک کارل این بود که به عنوان یک PDF بر اساس یک سند ورد در سال ۲۰۰۲ ظاهر شد. این قالب در راحت ترین شکل CHM با انتشار نسخه ۲۲.۱ در مارس ۲۰۰۶ بازسازی شد و در نسخه ۲۲.۳ به عنوان راهنمای GAMS Expanded (McCarl) در نوامبر ۲۰۰۶ تغییر نام داد. همچنین راهنمای اصلی GAMS را در این زمان به عنوان PDF که از منبع LaTeX تولید شده بود ، نگه داشته شد. راهنمای جدید بروس با بهبود محتوا، سازماندهی و قابلیت ناوبری، نه تنها برای افرادی که دوره های او را گذرانده بودند، بلکه برای همه کاربران AMS ، مفید بود.

راهنمای توسعه یافته GAMS (McCarl) هرگز برای چاپ در نظر گرفته نشده بود و به صورت کپی با GAMS ارسال نشد. در سال ۲۰۱۳ ، GAMS حمل و نقل فیزیکی را به طور کلی متوقف کرد و به سیستم تحویل سفارشات آنلاین رفت. برای کسانی که هنوز اسناد چاپی می خواستند، اسناد نیز از طریق CreatSpace آمازون در دسترس قرار گرفت، اما اکثر کاربران اسناد را به صورت آنلاین یا به عنوان بخشی از یک سیستم نصب شده GAMS ، اغلب از طریق GAMS IDE مرور کردند، بنابراین نیاز به اسناد قابل چاپ روز به روز کمتر می­شد.

داشتن دو راهنمای کاربر برای برخی از کاربران غیرقابل تصور یا گیج کننده بود ، به ویژه هنگامی که محتوای برخی از موضوعات متفاوت ، مفقود و یا حتی متناقض بود. تلاش اضافی مورد نیاز برای نگهداری دو سند بیشتر مشهود شد ، به ویژه از آنجا که راهنمای کاربر گسترده (McCarl) با استفاده از یک محصول فقط برای ویندوز اجرا می شد که خود را از طریق SVN یا git به کنترل نسخه وامی نداشت. هنگامی که API های شی گرا را در فوریه ۲۰۱۳ مستند شد ، از این فرصت استفاده شد تا یک فرایند مبتنی بر doxygen آزمایش شود که از فایل های متنی به عنوان منبع استفاده می کند، مستقل از پلتفرم است و خروجی را در چندین فرمت تولید می کند. نتایج خوب بود، و در سال ۲۰۱۵ یک مشاور، مارتا لوو، استخدام شد تا در مورد چگونگی تبدیل همه اسناد GAMS با استفاده فرایند مبتنی بر doxygen و ایجاد چارچوبی برای این کار تحقیق کند. سرانجام کاملاً به این فرایند متعهد شدند و مجموعه ای از اسناد یکپارچه را از تاریخ انتشار نسخه ۲۴.۹ در آگوست ۲۰۱۷ تهیه شده است. این شامل سازماندهی مجدد موارد برای متناسب شدن بهتر یک سند پیوندی ، ادغام دو راهنمای کاربر در یک نسخه (در حالی که سعی شد بهترین کیفیت از هر نسخه در نظر گرفته شد)، اضافه کردن پیوندها در سراسر راهنما، و ارسال همه چیز برای بازبینی و ویرایش توسط متخصصان تا محتوا دقیق، به روز و کامل باشد. نتیجه نهایی چیزی است که ما معتقدیم پیشرفت نسبت به نسخه های قبلی خود دارد.

جدول زمانی اسناد منتشر شده با نرم افزار GAMS