Re: [Libmesh-devel] How to develop a new example?

[Derek Gaston <friedmud@gm...>]

Thanks for getting back to me...


On Sat, Jan 19, 2013 at 4:37 PM, Kirk, Benjamin (JSC-EG311) <
benjamin.kirk-1@...> wrote:

> You do not to build in a separate directory unless you want to.  I do this
> so I can use many different compilers on a number of machines that all
> share the same source tree on my shared linux filesystem, but I build in
> the top directory on my mac.
>

Hmmm.... we did some testing with this this week and there are a couple of
issues:

1.  If you don't "make install" then Make.common does not get created
 (obviously not necessary for an example... but that is problematic for
some users).

2.  If you don't "make install" then bin/libmesh_config doesn't output the
proper include directories (or are we doing something wrong?).  Coupled
with #1 this means that not make installing doesn't seem to be an option
for actual application development... but are we missing something?

Not required to test your example.  You can now run your new example
> through our 'make check' target, without ever installing anything.  For
> example:
>
> make -C examples//mesh_transfer/simple_dtk check
>
> will build and run your example from the source tree.
>

Well, that assumes that your example is all working in the first place ;-)
 When developing a new example for a new feature I expect to do hundreds of
build/run cycles (probably including many debug runs as well) and most of
those won't work in someway...

But it is good to know.


> So with that workflow, your one terminal should suffice from here….
>

I'll try to go back to not doing out of tree builds and see if I can get it
to work.  I really hope so!

Thanks again for the reply,

Derek

Re: [Libmesh-devel] How to develop a new example?

[Kirk, Benjamin (JSC-EG311) <benjamin.kirk-1@na...>]

On Jan 19, 2013, at 5:26 PM, Derek Gaston <friedmud@...> wrote:

> So, here's my workflow for adding a new example (in a new examples directory).
> 
> cd libmesh/examples
> mkdir mesh_transfer
> cp -r introduction/introduction_ex3 mesh_transfer/simple_dtk
> cd mesh_transfer/simple_dtk
> # Rename files to simple_dtk (or whatever)
> # Edit Makefile.am to include the name of the new files
> cd ../..
> # Edit Makefile.am to include new directory
> cd .. (to the "libmesh" directory)
> # Edit configure.ac to include the new example's Makefile
> ./bootstrap

Yes to here.

> mkdir build

You do not to build in a separate directory unless you want to.  I do this so I can use many different compilers on a number of machines that all share the same source tree on my shared linux filesystem, but I build in the top directory on my mac.

> cd build
> METHODS="opt dbg" ../configure --prefix=$LIBMESH_ROOT/installed
> make

Yes, caveat the ../configure …  as noted above.

Also, if you want a shortcut to reconfigure with your last options just use

./config.status --recheck

In fact, if you boostrap and forget to reconfigure your next 'make' should do it for you.

> make install

Not required to test your example.  You can now run your new example through our 'make check' target, without ever installing anything.  For example:

make -C examples//mesh_transfer/simple_dtk check

will build and run your example from the source tree.

So with that workflow, your one terminal should suffice from here….

-Ben

Re: [Libmesh-devel] How to develop a new example?

[Kirk, Benjamin (JSC-EG311) <benjamin.kirk-1@na...>]

On Jan 19, 2013, at 4:14 PM, Derek Gaston <friedmud@...> wrote:

> So,
> 
> With the new build system what's the best way to develop a new example?
> 
> Previously I would do this:
> 
> cd libmesh/examples/introduction
> cp introduction_ex3 introduction_ex17
> # Change everything in introduction_ex17 to say ex17
> make
> ./introduction_ex17



Basically you do as before, but you will also need to add your new example in

(1) configure.ac (it'll be obvious, inside the construct at line 257)
(2) examples/Makefile.am, add to the subdirs flag.

Since you edited configure.ac you will need to bootstrap and configure, but if everything is working properly 'make && make check' should only build your new example because your reconfigure will not have changed anything required to build libMesh.

-Ben

Re: [Libmesh-devel] How to develop a new example?

[Derek Gaston <friedmud@gm...>]

So, here's my workflow for adding a new example (in a new examples
directory).

cd libmesh/examples
mkdir mesh_transfer
cp -r introduction/introduction_ex3 mesh_transfer/simple_dtk
cd mesh_transfer/simple_dtk
# Rename files to simple_dtk (or whatever)
# Edit Makefile.am to include the name of the new files
cd ../..
# Edit Makefile.am to include new directory
cd .. (to the "libmesh" directory)
# Edit configure.ac to include the new example's Makefile
./bootstrap
mkdir build
cd build
METHODS="opt dbg" ../configure --prefix=$LIBMESH_ROOT/installed
make
make install

# That will setup the basic environment.  Now, open _3_ terminals to the
following directories:
libmesh/examples/mesh_transfer/simple_dtk
libmesh/build/examples/mesh_transfer/simple_dtk
libmesh/installed/examples/mesh_transfer/simple_dtk

# Now start modifying example and do this for every modification:

# Snag libmesh/examples terminal.
# Edit any files in the example
# Edit Makefile.am to add any new files

# Snag libmesh/build/examples terminal.
make install

# Snag libmesh/installed/examples terminal.
make
./example-opt  # To actually run the example

# Repeat

Guys, seriously.  This is really they way you want to work?  You _really_
want to have 3 directories to interact with every time you make a change?
 Every time you add a file you really want to modify a file to tell the
build system about it?

If my software worked this way... not ONE single person would ever use it.
 I guarantee you that this build system will limit casual developers from
contributing to libMesh (maybe that was one of the intentions...)

I suppose I should be grateful that at least I don't have to reconfigure
for every cycle... I was really worried that I was going to have to...

Derek



On Sat, Jan 19, 2013 at 3:14 PM, Derek Gaston <friedmud@...> wrote:

> So,
>
> With the new build system what's the best way to develop a new example?
>
> Previously I would do this:
>
> cd libmesh/examples/introduction
> cp introduction_ex3 introduction_ex17
> # Change everything in introduction_ex17 to say ex17
> make
> ./introduction_ex17
>
> What's the best way of doing that now?
>
> If I do the above and copy an example... then I have to reconfigure to get
> it copied to my "build" directory... and then "make install" to get it
> built and copied into my install directory.
>
> But where do I edit it then?  I suppose I edit it in
> libmesh/examples/introduction/introduction_ex17 and then build and make
> install in my build directory?  If I add more files to my example do I need
> to reconfigure to get a new Makefile made?  Then rebuild the whole library
> so I can build my example?
>
> I'm hoping there is a better way.
>
> /me is still not a fan of the new build system.
>
> Derek
>

Re: [Libmesh-devel] How to develop a new example?

[Roy Stogner <roystgnr@ic...>]

On Sat, 19 Jan 2013, Roy Stogner wrote:

> the git commands

Actually, speaking of the git commands, there is one big hassle:

Make sure that you re-run bootstrap before committing any build system
commits, and be sure to re-run it with the versions of automake,
autoconf, and libtool from libmesh contrib/autotools/; that keeps the
diffs from version to version tractable.
---
Roy

Re: [Libmesh-devel] How to develop a new example?

[Roy Stogner <roystgnr@ic...>]

On Sat, 19 Jan 2013, Derek Gaston wrote:

> What are the steps necessary for adding a new file (like new a new header file and associated
> .C) to libMesh now?

Check out Ben's include/rebuild_include_HEADERS.sh and
src/rebuild_libmesh_SOURCES.sh; IIRC those do all the magic (other
than the git commands that you're probably more familiar with than we
are) to make sure that new headers get installed and symlinked in
include/libmesh, new objects get built, etc. correctly.
---
Roy

Re: [Libmesh-devel] How to develop a new example?

[Derek Gaston <friedmud@gm...>]

And actually... a follow on question.

What are the steps necessary for adding a new file (like new a new header
file and associated .C) to libMesh now?

Thanks,
Derek



On Sat, Jan 19, 2013 at 3:14 PM, Derek Gaston <friedmud@...> wrote:

> So,
>
> With the new build system what's the best way to develop a new example?
>
> Previously I would do this:
>
> cd libmesh/examples/introduction
> cp introduction_ex3 introduction_ex17
> # Change everything in introduction_ex17 to say ex17
> make
> ./introduction_ex17
>
> What's the best way of doing that now?
>
> If I do the above and copy an example... then I have to reconfigure to get
> it copied to my "build" directory... and then "make install" to get it
> built and copied into my install directory.
>
> But where do I edit it then?  I suppose I edit it in
> libmesh/examples/introduction/introduction_ex17 and then build and make
> install in my build directory?  If I add more files to my example do I need
> to reconfigure to get a new Makefile made?  Then rebuild the whole library
> so I can build my example?
>
> I'm hoping there is a better way.
>
> /me is still not a fan of the new build system.
>
> Derek
>

[Libmesh-devel] How to develop a new example?

[Derek Gaston <friedmud@gm...>]

So,

With the new build system what's the best way to develop a new example?

Previously I would do this:

cd libmesh/examples/introduction
cp introduction_ex3 introduction_ex17
# Change everything in introduction_ex17 to say ex17
make
./introduction_ex17

What's the best way of doing that now?

If I do the above and copy an example... then I have to reconfigure to get
it copied to my "build" directory... and then "make install" to get it
built and copied into my install directory.

But where do I edit it then?  I suppose I edit it in
libmesh/examples/introduction/introduction_ex17 and then build and make
install in my build directory?  If I add more files to my example do I need
to reconfigure to get a new Makefile made?  Then rebuild the whole library
so I can build my example?

I'm hoping there is a better way.

/me is still not a fan of the new build system.

Derek