Managing packages in the workbench
in [Mathematica]
|
From: Hannes Kessler on 22 Mar 2010 03:40 Hello, the thread http://groups.google.de/group/comp.soft-sys.math.mathematica/browse_thread/thread/a67d924983da8c34# has several good recommendations for the transition to the workbench, thanks to John Fultz, Albert Retey, Adam Berry, David Park and others. Nevertheless, I was not successful to get my packages into workbench management and need som further advice. The Workbench help system wasn't really helpful as all concrete examples relate to the trivial standard case. Anyways, here is my problem with an example: I imported the NumericalAnalysis project from the Wolfram website (http://www.wolfram.com/products/workbench/examples/ ExampleProjects.zip) to the Workbench. Next, I modified In NumericalAnalysis.m the BeginPackage statement to BeginPackage["Math`NumericalAnalysis`"] and in init.m the Get statement to Get["Math`NumericalAnalysis`NumericalAnalysis`"]. Then I built the documentation in the ApplicationTools and exported the application to the directory $UserBaseDirectory/Applications/Math/ (instead to the standard $UserBaseDirectory/Applications). The resulting basic file structure is $UserBaseDirectory/Applications/Math/NumericalAnalysisDocumentation/.. $UserBaseDirectory/Applications/Math/NumericalAnalysis/Kernel/init.m $UserBaseDirectory/Applications/Math/NumericalAnalysis/ NumericalAnalysis.m $UserBaseDirectory/Applications/Math/NumericalAnalysis/PacletInfo.m Needs["Math`NumericalAnalysis`"] works as expected, but the documentation is not found. I played with the project settings "Paclet Location" and "Documentation Location" (setting these to Math/NumericalAnalysis and Math/NumericalAnalysis/Documentation). I tried also modifying the PacletInfo.m file with Extensions -> {{"Documentation", Resources -> {"Guides/NumericalAnalysis"}, Language -> "English", LinkBase -> "Math"}}, but without any success. The NumericalAnalysis help files were not found. So how should one modify the standard Workbench settings to make the help files accessible? Help is greatly appreciated. Best regards, Hannes Kessler
From: David Park on 23 Mar 2010 05:23 Basically, I wouldn't mess around with the default settings. When deploying the application check the $UserBaseDirectory box to determine the location and deploy to there, which should be your private Applications folder. I think you may have gotten an extra Math directory into your structure and then Mathematica won't find the documentation. When creating a new application, "MyApplication" (say): 1) Create an Application Project with name "MyApplicationProject" (say). 2) Give the application the name "MyApplication". This will also be the PacletName. The paclet name is the same as the application name. You can have more than one package but they will all be in the same application and all their routines be documented under the same single paclet. 3) WRI seems to concentrate on the case where there is only a single package and the package name is the same as the application name. In that case, your package name would be MyApplication`MyApplication.m. The BeginPackage statement would be BeginPackage["MyApplication`MyApplication`"] and the entire application would be contained in a MyApplication folder directly within your $UserBaseDirectory/Applications folder. The init.m file would contain the statement Get["MyApplication`MyApplication`"] and the package could be loaded with <<MyApplication`, which will evaluate the init.m file. 4) But you might want to give the package a different name than the application, or you might have several packages. Suppose you have two packages: PackageA.m and PackageB.m, with BeginPackage["MyApplication`PackageA`"] etc. The init.m file would load both packages. All packages would still be loaded with <<MyApplication`. 5) But there is one caveat. To get all the usage message links you have to add an undocumented specification to PacletInfo.m. Under Extensions -> add an item: {"Kernel", "Context"-> {"MyApplication`PackageA`","MyApplication`PackageB`"}} Not only is this undocumented, but it will display warning messages in the PacletInfo.m display. It will also display an "Unknown" folder in the Extensions tab. The warnings can be ignored. I assume this will be straightened up in the next release. That's the basic structure. I wouldn't experiment with putting things in out of the way places until you can get the basic structure working. You should be able to go with the default settings for locations. David Park djmpark(a)comcast.net http://home.comcast.net/~djmpark/ From: Hannes Kessler [mailto:HannesKessler(a)hushmail.com] Hello, the thread http://groups.google.de/group/comp.soft-sys.math.mathematica/browse_thread/t hread/a67d924983da8c34# has several good recommendations for the transition to the workbench, thanks to John Fultz, Albert Retey, Adam Berry, David Park and others. Nevertheless, I was not successful to get my packages into workbench management and need som further advice. The Workbench help system wasn't really helpful as all concrete examples relate to the trivial standard case. Anyways, here is my problem with an example: I imported the NumericalAnalysis project from the Wolfram website (http://www.wolfram.com/products/workbench/examples/ ExampleProjects.zip) to the Workbench. Next, I modified In NumericalAnalysis.m the BeginPackage statement to BeginPackage["Math`NumericalAnalysis`"] and in init.m the Get statement to Get["Math`NumericalAnalysis`NumericalAnalysis`"]. Then I built the documentation in the ApplicationTools and exported the application to the directory $UserBaseDirectory/Applications/Math/ (instead to the standard $UserBaseDirectory/Applications). The resulting basic file structure is $UserBaseDirectory/Applications/Math/NumericalAnalysisDocumentation/.. $UserBaseDirectory/Applications/Math/NumericalAnalysis/Kernel/init.m $UserBaseDirectory/Applications/Math/NumericalAnalysis/ NumericalAnalysis.m $UserBaseDirectory/Applications/Math/NumericalAnalysis/PacletInfo.m Needs["Math`NumericalAnalysis`"] works as expected, but the documentation is not found. I played with the project settings "Paclet Location" and "Documentation Location" (setting these to Math/NumericalAnalysis and Math/NumericalAnalysis/Documentation). I tried also modifying the PacletInfo.m file with Extensions -> {{"Documentation", Resources -> {"Guides/NumericalAnalysis"}, Language -> "English", LinkBase -> "Math"}}, but without any success. The NumericalAnalysis help files were not found. So how should one modify the standard Workbench settings to make the help files accessible? Help is greatly appreciated. Best regards, Hannes Kessler
From: Hannes Kessler on 24 Mar 2010 05:31 Thanks David for your comments and the hint to the "Kernel"-extension. The basic structure you mentioned works of course. However, I have all my packages (many) in a logical hierarchical directory structure in the private Applications folder. It works fine in Mathematica. Rearranging this package system to a plain directory structure requires a lot of package context editing and a lot of time. That's my problem. In addition, much of the order is lost. For this reason I was hoping that it is possible to add help files to the package system in its present order. Best regards, Hannes Kessler On 23 Mrz., 10:23, "David Park" <djmp...(a)comcast.net> wrote: > Basically, I wouldn't mess around with the default settings. When deployi= ng > the application check the $UserBaseDirectory box to determine the locatio= n > and deploy to there, which should be your private Applications folder. I > think you may have gotten an extra Math directory into your structure and > then Mathematica won't find the documentation. > > When creating a new application, "MyApplication" (say): > > 1) Create an Application Project with name "MyApplicationProject" (say). > > 2) Give the application the name "MyApplication". This will also be the > PacletName. The paclet name is the same as the application name. You can > have more than one package but they will all be in the same application a= nd > all their routines be documented under the same single paclet. > > 3) WRI seems to concentrate on the case where there is only a single pack= age > and the package name is the same as the application name. In that case, y= our > package name would be MyApplication`MyApplication.m. The BeginPackage > statement would be BeginPackage["MyApplication`MyApplication`"] and the > entire application would be contained in a MyApplication folder directly > within your $UserBaseDirectory/Applications folder. The init.m file would > contain the statement Get["MyApplication`MyApplication`"] and the package > could be loaded with <<MyApplication`, which will evaluate the init.m fil= e. > > 4) But you might want to give the package a different name than the > application, or you might have several packages. Suppose you have two > packages: PackageA.m and PackageB.m, with > BeginPackage["MyApplication`PackageA`"] etc. The init.m file would load b= oth > packages. All packages would still be loaded with <<MyApplication`. > > 5) But there is one caveat. To get all the usage message links you have t= o > add an undocumented specification to PacletInfo.m. Under Extensions -> ad= d > an item: > > {"Kernel", "Context"-> > {"MyApplication`PackageA`","MyApplication`PackageB`"}} > > Not only is this undocumented, but it will display warning messages in th= e > PacletInfo.m display. It will also display an "Unknown" folder in the > Extensions tab. The warnings can be ignored. I assume this will be > straightened up in the next release. > > That's the basic structure. I wouldn't experiment with putting things in = out > of the way places until you can get the basic structure working. You shou= ld > be able to go with the default settings for locations. > > David Park > djmp...(a)comcast.nethttp://home.comcast.net/~djmpark/ > > From: Hannes Kessler [mailto:HannesKess...(a)hushmail.com] > > Hello, > > the threadhttp://groups.google.de/group/comp.soft-sys.math.mathematica/br= owse_t... > hread/a67d924983da8c34# > has several good recommendations for the transition to the workbench, > thanks to John Fultz, Albert Retey, Adam Berry, David Park and others. > Nevertheless, I was not successful to get my packages into workbench > management and need som further advice. The Workbench help system > wasn't really helpful as all concrete examples relate to the trivial > standard case. Anyways, here is my problem with an example: > > I imported the NumericalAnalysis project from the Wolfram website > (http://www.wolfram.com/products/workbench/examples/ > ExampleProjects.zip) to the Workbench. Next, I modified In > NumericalAnalysis.m the BeginPackage statement to > BeginPackage["Math`NumericalAnalysis`"] and in init.m the Get > statement to Get["Math`NumericalAnalysis`NumericalAnalysis`"]. Then I > built the documentation in the ApplicationTools and exported the > application to the directory $UserBaseDirectory/Applications/Math/ > (instead to the standard $UserBaseDirectory/Applications). The > resulting basic file structure is > > $UserBaseDirectory/Applications/Math/NumericalAnalysisDocumentation/.. > $UserBaseDirectory/Applications/Math/NumericalAnalysis/Kernel/init.m > $UserBaseDirectory/Applications/Math/NumericalAnalysis/ > NumericalAnalysis.m > $UserBaseDirectory/Applications/Math/NumericalAnalysis/PacletInfo.m > > Needs["Math`NumericalAnalysis`"] works as expected, but the > documentation is not found. > > I played with the project settings "Paclet Location" and > "Documentation Location" (setting these to Math/NumericalAnalysis and > Math/NumericalAnalysis/Documentation). I tried also modifying the > PacletInfo.m file with Extensions -> {{"Documentation", Resources -> > {"Guides/NumericalAnalysis"}, Language -> "English", LinkBase -> > "Math"}}, but without any success. The NumericalAnalysis help files > were not found. So how should one modify the standard Workbench > settings to make the help files accessible? > > Help is greatly appreciated. > > Best regards, > Hannes Kessler
From: David Bailey on 25 Mar 2010 05:25 Hannes Kessler wrote: > However, I have all my packages (many) in a logical hierarchical > directory structure in the private Applications folder. It works fine > in Mathematica. Rearranging this package system to a plain directory > structure requires a lot of package context editing and a lot of time. > That's my problem. In addition, much of the order is lost. For this > reason I was hoping that it is possible to add help files to the > package system in its present order. > Perhaps the most obvious question is, why do you want to use the Workbench - there may be other ways to achieve what you want to do! I too have things set up to my taste, and I don't want to change the way I work to suit the Workbench. David Bailey http://www.dbaileyconsultancy.co.uk
From: H. Keßler on 26 Mar 2010 06:35 My primary problem is that I would like to create help pages of Mathematica packages stored in directories which are not at the top level of my private Mathematica Applications directory. The Workbench creates hyperlinked help pages for such packages which work inside the Workbench but not when exported to the corresponding subdirectory of the Mathematica Applications directory. I checked the example you provided on your homepage (http://www.dbaileyconsultancy.co.uk/ m_documentation/m_documentation.html). But it seems that this example also deals with help pages for a package in a directory which is on the top level of the Mathematica Applications directory. If I am wrong, please correct me. But I would really appreciate if you can provide more details how to deal with packages in in deeper subdirectories of the Mathematica Applications directory, no matter of using the Workbench or some other approach. Best regards, Hannes Kessler On 25 Mrz., 10:25, David Bailey <d...(a)removedbailey.co.uk> wrote: > Hannes Kessler wrote: > > However, I have all my packages (many) in a logical hierarchical > > directory structure in the private Applications folder. It works fine > > in Mathematica. Rearranging this package system to a plain directory > > structure requires a lot of package context editing and a lot of time. > > That's my problem. In addition, much of the order is lost. For this > > reason I was hoping that it is possible to add help files to the > > package system in its present order. > > Perhaps the most obvious question is, why do you want to use the > Workbench - there may be other ways to achieve what you want to do! > > I too have things set up to my taste, and I don't want to change the way > I work to suit the Workbench. > > David Baileyhttp://www.dbaileyconsultancy.co.uk
|
Next
|
Last
Pages: 1 2 3 Prev: Mathematica SIG (Washington DC Area) Next: Sorting Filenames into HTML Coding |